/

Configuration reference

APIdocs is an opinionated theme built for a specific set of software products in mind. For this reason, the number of options you can configure is currently limited.

gatsby-theme-apidocs

The gatsby-theme-apidocs theme exposes the following options:

basePath

The base path to assume when converting HTML content file paths to page identifiers. For example, if your configuration sources HTML files from the src/content directory, set basePath to src/content.

navigation

Path to the navigation JSON file.

Path to the site logo file.

footer

Path to the site footer file.

variables

A map of variables and their values to use during variable substitution.

gatsby-config.js

Some properties of your site can be configured in the siteMetadata section of gatsby-config.js.

title

The string to use in the head > title tag of the resulting HTML.

description

The text to use in the description meta tag. This is the one you want to edit for good SEO results.

lang

The contents of the lang attribute of the html tag.

indexAlias

Identifier of the page to copy to be served at the root / URL of your site. Use both leading and trailing slash when providing the alias, for example: /getting-started/.