Skip to content

Commit f1247c5

Browse files
authored
Merge pull request #1235 from benogle/bo/add-spectaql
Add SpectaQL to the Code page's list of javascript tools
2 parents 96ed223 + 0613564 commit f1247c5

File tree

1 file changed

+26
-0
lines changed
  • src/content/code/language-support/javascript/tools

1 file changed

+26
-0
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: SpectaQL
3+
description: SpectaQL generates static HTML documentation from a GraphQL schema.
4+
url: https://github.com/anvilco/spectaql
5+
github: anvilco/spectaql
6+
npm: "spectaql"
7+
---
8+
9+
SpectaQL is a Node.js library that generates static documentation for a GraphQL schema using a variety of options:
10+
11+
* From a live endpoint using the introspection query.
12+
* From a file containing an introspection query result.
13+
* From a file, files or glob leading to the schema definitions in SDL.
14+
15+
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.
16+
17+
```sh
18+
npm install --dev spectaql
19+
# OR
20+
yarn add -D spectaql
21+
22+
# Then generate your docs
23+
npm run spectaql my-config.yml
24+
# OR
25+
yarn spectaql my-config.yml
26+
```

0 commit comments

Comments
 (0)