The docmd.config.json file serves as the central configuration manifest for your documentation workspace. It manages site branding, navigation sidebars, localisation parameters, and static site compiler options.

Configuration Schema Formats

JSON is the primary configuration format, allowing high-performance serialisation across worker threads during parallel builds:

{
  "title": "My Technical Docs",
  "url": "https://docs.example.com",
  "src": "docs",
  "out": "site",
  "base": "/"
}

For dynamic setups requiring environment variables or programmatic logic, docmd.config.ts and docmd.config.js are fully supported:

import { UserConfig } from '@docmd/api';

const config: UserConfig = {
  title: process.env.DOCS_TITLE || 'My Technical Docs',
  src: 'docs',
  out: 'site'
};

export default config;

module.exports = {
  title: process.env.DOCS_TITLE || 'My Technical Docs',
  src: 'docs',
  out: 'site'
};

Core Settings

These top-level properties configure base paths and global compiler options:

Branding & Identity

Configure brand logos and browser favicons in docmd.config.json:

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

UI Layout and Behaviour

Configure headers, sidebars, search placement, and theme toggles:

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

Refer to the Layout & UI Zones guide for comprehensive visual customisation options.

Core Compiler Options

Fine-tune how docmd parses and transforms your Markdown content:

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