SpectaQL theme usage example

This is an example Node.js project using the SpectaQL dark theme with SpectaQL to generate GraphQL documentation. It is minimal in an effort to show you how to integrate SpectaQL and a custom theme into your own app.

The result looks like this:

---

This example is provided by Anvil. Anvil provides easy APIs for all things paperwork.

1. PDF filling API - fill out a PDF template with a web request and structured JSON data.
2. PDF generation API - send markdown or HTML and Anvil will render it to a PDF.
3. Etch e-sign with API - customizable, embeddable, e-signature platform with an API to control the signing process end-to-end.
4. Anvil Workflows (w/ API) - Webforms + PDF + e-sign with a powerful no-code builder. Easily collect structured data, generate PDFs, and request signatures.

Learn more on our Anvil developer page.

Usage

Usage is simple: install the dependencies, then build your docs. It uses SpectaQL's example schema.

yarn install

# Run the docs on a dev server
yarn docs:develop

# Build the static site HTML
yarn docs:build

You can fork the example and point it to your own schema by updating the introspection key in spectaql-config.yml.

Local theme

Instead of using a theme from NPM, you can use a local directory as a theme. Fork this project, create a local theme directory, and update the spectaql.themeDir yaml key to point to your local theme directory.

See the theme readme and SpectaQL theming blog post for more details.