Configuration
All Dory configuration lives in a single dory.json file at the project root. Pages can live in docs/. Here is an example:
JSON
{
"name": "My Docs",
"title": "My Docs — Developer Reference",
"description": "The official documentation for My Project.",
"url": "https://docs.myproject.com",
"image": "/og-card.png",
"twitter": "@myhandle",
"favicon": "./favicon.svg",
"colors": {
"primary": "#6366f1",
"light": "#818cf8",
"dark": "#4f46e5"
},
"fonts": {
"family": "Inter",
"source": "https://fonts.gstatic.com/...",
"format": "woff2"
},
"logo": {
"light": "./logo/logo.svg",
"dark": "./logo/logo-dark.svg"
},
"navigation": {
"tabs": [
{
"tab": "Documentation",
"groups": [
{
"group": "Getting Started",
"pages": ["introduction", "installation"]
}
]
},
{
"tab": "API Reference",
"groups": [
{
"group": "Endpoints",
"pages": ["api/create", "api/update", "api/delete"]
}
]
}
]
},
"analytics": {
"posthog": {
"token": "phc_your_token",
"apiHost": "https://us.i.posthog.com"
}
}
}
Top-Level Fields#
| Field | Required | Description |
|---|---|---|
name | Yes | Site name shown in the header and browser tab. |
title | No | Custom page title. Defaults to name. |
description | No | Short description used for SEO. |
url | No | Your site's URL, used for social sharing previews. |
image | No | Preview image shown when sharing links on social media. |
twitter | No | Your Twitter/X handle for social meta tags. |
favicon | Yes | Path to your favicon file (SVG or PNG). |
colors | No | Brand colors. See Theming. |
fonts | No | Custom font. See Fonts. |
logo | Yes | Logo paths for light and dark mode. |
navigation | Yes | Navigation structure. See Navigation. |
analytics | No | Analytics integrations. See Analytics. |
i18n | No | Translated content. See Languages and versions. |
versions | No | Versioned content. See Languages and versions. |
embed | No | Embeddable widget config. See Embed. |
Configuration Sections#
Was this page helpful?