From 06135644d4c7a1951b95f76e4383989dc8bbb4f8 Mon Sep 17 00:00:00 2001 From: Ben Ogle Date: Wed, 18 May 2022 17:30:09 -0700 Subject: [PATCH] Add SpectaQL to the list of javascript tools --- .../javascript/tools/spectaql.md | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 src/content/code/language-support/javascript/tools/spectaql.md diff --git a/src/content/code/language-support/javascript/tools/spectaql.md b/src/content/code/language-support/javascript/tools/spectaql.md new file mode 100644 index 0000000000..6751a3a0f1 --- /dev/null +++ b/src/content/code/language-support/javascript/tools/spectaql.md @@ -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 +```