DoryDocs

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#

FieldRequiredDescription
nameYesSite name shown in the header and browser tab.
titleNoCustom page title. Defaults to name.
descriptionNoShort description used for SEO.
urlNoYour site's URL, used for social sharing previews.
imageNoPreview image shown when sharing links on social media.
twitterNoYour Twitter/X handle for social meta tags.
faviconYesPath to your favicon file (SVG or PNG).
colorsNoBrand colors. See Theming.
fontsNoCustom font. See Fonts.
logoYesLogo paths for light and dark mode.
navigationYesNavigation structure. See Navigation.
analyticsNoAnalytics integrations. See Analytics.
i18nNoTranslated content. See Languages and versions.
versionsNoVersioned content. See Languages and versions.
embedNoEmbeddable widget config. See Embed.

Configuration Sections#

Navigation

Configure tabs, groups, and pages in the sidebar.

Theming

Set primary, light, and dark brand colors.

Fonts

Use a custom web font from Google Fonts or any CDN.

Analytics

Integrate PostHog for page view tracking.

Documentation chat

Configure a server-side model for cited answers.

Languages and versions

Organize localized and versioned pages.

Embed

Configure the embeddable widget for external sites.

Full Reference

Complete dory.json reference with all fields.

Was this page helpful?