Skip to Content

Configuration

The fields of docs.config.ts.

Everything that differs between projects is in docs.config.ts, at the root of the repository. The file is typed, so npm run typecheck reports a missing or misspelled field.

Fields

FieldExampleUse
nameHatcheryThe name in title case, in titles and alt text
slughatcheryThe lowercase name, for URLs and commands
descriptionOne sentenceUnder the wordmark and in the page metadata
areaPlugin distributionThe label above the wordmark: "Aiviarium / Plugin distribution"
colour.dark#E879F9The project colour on dark
colour.light#A21CAFThe project colour on white
repohttps://github.com/aiviarium/hatcheryThe GitHub link and the edit links
repoDocsPathdocs/content/docsWhere the pages are in the repository
badgev0.1A short badge beside the name in the header
installA label and a commandThe install block on the landing page
actionsA pair of linksThe buttons on the landing page
assetsPaths in public/The icons and wordmarks
navA list of linksThe links in the header
featuresA list of cardsThe cards on the landing page, or an empty list

The project colour

The site reads the two colours into one CSS variable, --brand. The dark tone is used on the dark theme, and the light tone on the light theme. The light tone is darker, so text in it passes 4.5:1 on white.

The colour marks text, links, 1 px borders and small markers. Panels, cards, buttons, badges, callouts, code blocks and table cells stay grey. Keep to this rule when you add your own components.

The base path

A site served from a folder, such as https://aiviarium.github.io/hatchery/, needs the folder name at build time:

DOCS_BASE_PATH=/hatchery npm run build

Links, the search index and the Markdown files then include the folder. Leave the variable unset for a site at the root of a domain.

Edit on GitHub

Last updated on

On this page