Skip to content

Add SpectaQL to the Code page's list of javascript tools #1235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 24, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions src/content/code/language-support/javascript/tools/spectaql.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: SpectaQL
description: SpectaQL generates static HTML documentation from a GraphQL schema.
url: https://github.com/anvilco/spectaql
github: anvilco/spectaql
npm: "spectaql"
---

SpectaQL is a Node.js library that generates static documentation for a GraphQL schema using a variety of options:

* From a live endpoint using the introspection query.
* From a file containing an introspection query result.
* From a file, files or glob leading to the schema definitions in SDL.

Out of the box, SpectaQL generates a single 3-column HTML page and lets you choose between a couple built-in themes. A main goal of the project is to be easily and extremely customizable--it is themeable and just about everything can be overridden or customized.

```sh
npm install --dev spectaql
# OR
yarn add -D spectaql

# Then generate your docs
npm run spectaql my-config.yml
# OR
yarn spectaql my-config.yml
```