spectaql-dark-theme

SpectaQL Dark Theme

A dark theme for SpectaQL based on the default SpectaQL theme.

In mobile:

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

• PDF filling API - fill out a PDF template with a web request and structured JSON data.
• PDF generation API - send markdown or HTML and Anvil will render it to a PDF.
• Etch e-sign with API - customizable, embeddable, e-signature platform with an API to control the signing process end-to-end.
• 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

You can use this theme in two ways

• Pull the theme in as is from npm
• Fork the repo or otherwise copy the theme

1: Using the theme from NPM

The benefit of using the theme directly from NPM is that you will have an easy path to upgrade if/when there are bug fixes and improvements. See the example node repo for an example project using this theme via NPM.

Add both spectaql and spectaql-dark-theme to your repo as dev dependencies:

$ yarn add -D spectaql spectaql-dark-theme
# OR
$ npm install --dev spectaql spectaql-dark-theme

Then you can reference the theme in your SpectaQL config from node_modules.

spectaql:
  # Use the theme from node_modules
  themeDir: ./node_modules/spectaql-dark-theme/theme
  # The rest of your config...

See the example config.yml for a full example.

2: Usage by copying

It is likely you will want to modify the theme's colors and override styles. All you need to do is copy the entire theme directory into your project. Once you have the theme directory in the location of your choice, reference the theme in your SpectaQL config:

spectaql:
  themeDir: ./custom-location/docs/theme

See the example config.yml for a full example.

Generating docs with your new theme

When you have your config.yml setup from the one of the usage sections above, you can run SpectaQL as you would otherwise. From the root of your project

# View docs with a development server
$ yarn spectaql ./spectaql-config.yml -D
# Output docs to a file
$ yarn spectaql ./spectaql-config.yml -t ./build/docs

# View docs with a development server
$ npx spectaql ./spectaql-config.yml -D
# Output docs to a file
$ npx spectaql ./spectaql-config.yml -t ./build/docs

Related materials

• Building a SpectaQL theme for your GraphQL documentation - tutorial explaining how to build out a SpectaQL theme similar to this one.

License

MIT