Chiller
  1. Getting Started
  2. Config

The chiller.json config file has the following properties.

namestring
required

The name of your application. This is used in the page title.

faviconstring:path

The favicon file to use for the site. A relative path from your chiller.json file.

domainstring:url

The absolute url where you expect your docs application to be deployed. The domain is used to build links.

descriptionstring

Used in the meta for SEO

logostring | object

Relative path to the logo file to use in the header. Can be a string or an object with a `light` and `dark` property where you specify a different logo for each theme.

lightstring:path

Path to the logo that should be used when in light mode.

darkstring:path

Path to the logo that should be used when in dark mode.

pagesstring | string[]

A glob pattern string (or an array of glob strings) relative paths from your chiller.json config file that find all your documentaion pages. You can prefix a glob with `!` to filter those results out.

sidebarobject

An object describing how your sidebar should be layed out.

orderstring[]

If specified, should be a list of all sidebar groups in the order you want them displayed.

linksobject[]

Each link can have a `url`, `icon`, and `label` property.

urlstring:url
required

Target address to link to

iconstring

One of github, book, code, or chat

labelstring

If provided, the text shows in the link

headerobject

An object describing how your header should be layed out.

linksobject[]

Each link can have a `url`, `icon`, and `label` property.

urlstring:url
required

Target address to link to

iconstring

One of github, book, code, or chat

labelstring

If provided, the text shows in the link