Options

All available options in Smooth DOC.

All options can be specified at first level in your gatbsy-config.js. Read Getting Started to learn how to specify options.

Metadata

name [required]

string

The name of your project.

description [required]

string

The desription of your project. Used in HTML metadata and in manifest.

siteUrl

string

The URL of your website is required in most cases. If you use Netlify, it is automatically filled from environment variables.

shortName

string

The short name of your project (used in gatsby-plugin-manifest). If not provided, it fallbacks to name.

author

string

The author of your website. Used in HTML metadata.

Navigation

navItems

{ title: string, url: string }[]

Display nav items in header navigation. Read navigation guide for more information.

sections

string[]

Order sections in side navigation. Read Navigation guide for more information.

Social

twitterAccount

string

Display a Twitter link in header navigation.

GitHub

githubRepositoryURL

string

The GitHub repository URL of your project (no trailing slash). Display a GitHub logo in the header navigation. Read GitHub guide for more information.

githubDocRepositoryURL

string

The GitHub repository URL of your website (no trailing slash). Used to show edit links on documentation pages. Read GitHub guide for more information.

githubDefaultBranch

string

The default branch of your website repository, default to master. Used to show edit links on documentation pages. Read GitHub guide for more information.

baseDirectory

string

A path pointing to the base directory of the website. Used to show edit links on documentation pages. Read GitHub guide for more information.

Ads

carbonAdsURL

string

Your Carbon Ads URL. Read Display Ads guide to learn how to display ads on pages.

DocSearch

docSearch

{ apiKey: string, indexName: string }

Configuration of your Algolia DocSearch account. Read DocSearch guide for more information.