docs.json Reference
Complete configuration reference for your documentation site
The docs.json file is the central configuration for your Jamdesk documentation site.
Required Fields
name
Type: string (required)
Your documentation site's name. Displayed in the header and browser tab.
{ "name": "Acme API Docs" }theme
Type: "jam" | "nebula" | "pulsar" (required)
Clean, modern design with Inter font. Header-based navigation.
Best for: Most documentation sites, API references
Airy, relaxed feel with JetBrains Mono.
Best for: Narrative documentation, guides
Sharp, high-contrast with sidebar navigation.
Best for: Dense technical reference
colors
Type: object (required)
| Field | Type | Required | Description |
|---|---|---|---|
primary | string (hex) | Yes | Main brand color |
light | string (hex) | No | Light theme accent |
dark | string (hex) | No | Dark theme accent |
{
"colors": {
"primary": "#635BFF",
"light": "#7C75FF",
"dark": "#4F46E5"
}
}Branding
favicon
Type: string
Path to your favicon file (SVG recommended).
{ "favicon": "/images/favicon.svg" }logo
Type: object
| Field | Type | Description |
|---|---|---|
light | string | Logo for light mode |
dark | string | Logo for dark mode |
href | string | URL when logo is clicked |
{
"logo": {
"light": "/images/logo-light.svg",
"dark": "/images/logo-dark.svg",
"href": "https://yoursite.com"
}
}Navigation
hostAtDocs
This setting is controlled via the Dashboard project settings, not in docs.json.
When enabled in the dashboard, your site is served at /docs instead of the root. This is useful when hosting docs alongside a marketing site on the same domain.
navigation (structure)
Type: object
The navigation structure for your documentation. See Navigation for detailed documentation.
{
"navigation": {
"anchors": [
{
"anchor": "Docs",
"icon": "book-open",
"groups": [
{
"group": "Getting Started",
"pages": ["introduction", "quickstart"]
}
]
}
]
}
}Navbar & Footer
navbar
Type: object
| Field | Type | Description |
|---|---|---|
links | array | Navigation links |
primary | object | Primary CTA button |
{
"navbar": {
"links": [
{ "label": "Blog", "href": "/blog" }
],
"primary": {
"type": "button",
"label": "Dashboard",
"href": "https://app.example.com"
}
}
}footer
Type: object
{
"footer": {
"socials": {
"github": "https://github.com/yourorg",
"x": "https://x.com/yourhandle"
}
}
}Styling
styling.latex
Type: boolean
Enable LaTeX math rendering with KaTeX. When enabled, you can use $...$ for inline math and $$...$$ for block equations.
{
"styling": {
"latex": true
}
}See Math & LaTeX for usage details.
Full Example
{
"$schema": "https://jamdesk.com/docs.json",
"name": "Acme Documentation",
"description": "Learn how to use Acme",
"theme": "jam",
"colors": {
"primary": "#635BFF"
},
"favicon": "/images/favicon.svg",
"logo": {
"light": "/images/logo-light.svg",
"dark": "/images/logo-dark.svg"
},
"styling": {
"latex": true
},
"navbar": {
"links": [
{ "label": "Blog", "href": "/blog" }
],
"primary": {
"type": "button",
"label": "Dashboard",
"href": "https://app.acme.com"
}
},
"navigation": {
"anchors": [
{
"anchor": "Docs",
"icon": "book-open",
"groups": [
{
"group": "Get Started",
"pages": ["introduction", "quickstart"]
}
]
}
]
}
}