The docmd.config.json file is the central configuration for your workspace. It controls site styling, sidebar hierarchies, localisation details, and compiler options.

1. The Configuration Schema

JSON is the standard configuration format. This allows high-performance serialisation across the engine’s worker pools.

However, docmd.config.js and docmd.config.ts remain fully supported if you need dynamic JavaScript logic.

{
  "title": "My Project",
  "url": "https://docs.myproject.com",
  "src": "docs",
  "out": "site",
  "base": "/"
}

2. Core Settings

These top-level parameters configure the compiler’s base inputs and destinations.

3. Branding & Identity

Manage how your brand appears in the header and browser tabs.

{
  "logo": {
    "light": "assets/images/logo-dark.png",
    "dark": "assets/images/logo-light.png",
    "href": "/",
    "alt": "Company Logo",
    "height": "32px"
  },
  "favicon": "assets/favicon.ico"
}

4. UI Layout & Behaviour

The engine provides a modular header and sidebar layout. Customise functional regions. Change component visibility like search and dark-mode toggles. Enable or disable breadcrumbs.

{
  "layout": {
    "spa": true,
    "header": {
      "enabled": true
    },
    "sidebar": {
      "collapsible": true,
      "defaultCollapsed": false
    },
    "optionsMenu": {
      "position": "header",
      "components": {
        "search": true,
        "themeSwitch": true
      }
    }
  }
}

See the Layout & UI Zones guide for full visual customisation options.

5. Core Engine Features

Fine-tune how the parser processes your content files.

{
  "minify": true,
  "autoTitleFromH1": true,
  "copyCode": true,
  "pageNavigation": true,
  "markdown": {
    "breaks": true
  }
}