Config Reference
Reference for the docs.json fields you will use most often.
Top-Level Fields
Config version. Use 0.1.
Site name.
Site description for metadata and UI context.
Theme name. Relevate's production documentation uses oxide.
Logo path, or light and dark logo paths.
Favicon path.
Styling options.
Brand colors.
Theme mode settings.
Default changelog collection.
Named changelog collections.
Top navigation links and primary button.
Main docs structure, including tabs and optional languages.
Footer links and social links.
Redirect rules.
Search prompt text.
Not-found behavior.
Default theme mode.
If true, Relevate always uses the selected mode.
Primary accent color.
Light-mode accent color.
Dark-mode accent color.
Optional background colors for light and dark mode.
Public root for the default changelog collection, such as /changelog.
Public root for a named changelog collection.
{
"changelog": {
"path": "/changelog"
},
"changelogs": {
"api": {
"path": "/api/changelog"
}
}
}
Top-level tabs.
GraphQL SDL source for a generated reference tab. Use a local path or HTTPS URL, or provide source and an optional directory.
Language switcher settings.
Default language code.
Languages shown in the switcher.
A page, a page object, or a grouped section.
Optional language filter for a page or group.
Minimal Valid Config
{
"version": "0.1",
"name": "My Docs",
"navigation": {
"tabs": [
{
"id": "docs",
"label": "Documentation",
"content": ["index", "getting-started"]
},
{
"id": "changelog",
"label": "Changelog",
"icon": "clock",
"content": ["changelog"]
}
]
}
}
Minimal Multilingual Config
{
"version": "0.1",
"name": "My Docs",
"navigation": {
"languages": {
"default": "en",
"items": ["en", "fr", "jp"]
},
"tabs": [
{
"id": "docs",
"label": {
"en": "Docs",
"fr": "Documentation",
"jp": "ドã‚ュメント"
},
"content": ["index", "getting-started"]
}
]
}
}