All site configuration is managed through a single JSON file at docs/config.json. This file controls everything from your site name and colors to navigation structure and SEO settings.
Here's a minimal configuration to get started:
{
"$schema": "../docs.schema.json",
"name": "My Docs",
"url": "https://docs.example.com",
"theme": { "layout": "default" },
"colors": {
"primary": "#6366F1",
"primaryForeground": "#FFFFFF"
},
"navigation": {
"tabs": [
{
"tab": "Documentation",
"groups": [
{
"group": "Getting Started",
"pages": ["guides/introduction"]
}
]
}
]
}
}
Add "$schema": "../docs.schema.json" to enable autocomplete and validation in VS Code.
Your config.json must include these fields:
Display name for your documentation site.
Base URL of your site (e.g., https://docs.example.com).
Theme colors including primary and primaryForeground.
{
"name": "My Docs",
"description": "Documentation for my project",
"url": "https://docs.example.com",
"favicon": "/favicon.ico"
}
Choose from three layout themes:
- default - Top navbar with sidebar
- atlas - Sidebar-only layout (no top navbar)
- horizon - Navbar with pill-style search and sidebar dividers
{
"theme": {
"layout": "default"
},
"appearance": {
"default": "dark",
"strict": false,
"showToggle": true
}
}
Define your color palette with hex values:
{
"colors": {
"background": "#0C0A09",
"foreground": "#FAFAF9",
"card": "#1C1917",
"cardForeground": "#FAFAF9",
"primary": "#6366F1",
"primaryForeground": "#FFFFFF",
"border": "#27272A"
}
}
Structure your documentation with tabs, groups, and pages:
{
"navigation": {
"tabs": [
{
"tab": "Documentation",
"groups": [
{
"group": "Getting Started",
"icon": "rocket",
"pages": [
"guides/introduction",
"guides/getting-started/installation"
]
}
]
}
]
}
}
Page paths are relative to the docs/ directory without the .mdx extension. For example, guides/introduction maps to docs/guides/introduction.mdx.
Control search engine indexing and LLM crawler access:
{
"seo": {
"indexing": "navigable",
"sitemap": true,
"robots": true,
"llms": true,
"llmsFull": false
}
}
indexing
"navigable" | "all" | "none"
default: navigable
Which pages to index in sitemap and robots.txt.
Generate /llms.txt for LLM crawlers.
Generate /llms-full.txt with complete content.
Each MDX file supports frontmatter fields:
---
title: My Page Title
description: A brief description of the page
toc: true
layout: default
---
Page title for header and sidebar.
Page description for SEO.
layout
"default" | "reference"
default: default
Hide the footer on this page.
For a comprehensive list of all configuration options, see the config.json Reference.