Site Settings

Metadata

To start configuring the site settings (like metadata and GitHub repository), create a content/_config/settings.json5 file like so:

content/
├── _config/
│   └── settings.json5
...

The following example shows the full schema of settings.json5:

{
  "title": string, // important
  "description": string, // important
  "github": string // optional
}

Items marked with important, though not strictly required, are highly recommended to be set.

title

• Description: title of the web page; used for the HTML title tag and displayed in the Topnav
• Type: string
• Default: package.json title

description

• Description: description of the web page; used in the HTML meta tag for the description tag
• Type: string
• Default: package.json description

github

• Description: the <user>/<repo> where your source code is at; used to generate the correct link at the Topnav
• Type: string
• Default: null

Example

{
  "title": "Doconuxt",
  "description": "A @nuxt/content powered static site generator for Markdown content.",
  "github": "AaronCQL/doconuxt"
}

Favicon

To use a favicon, place it in a static/ directory and name it exactly favicon.ico.