Die Datei docmd.config.json dient als zentrales Konfigurationsmanifest für Ihren Dokumentations-Workspace. Sie verwaltet Website-Branding, Navigations-Sidebars, Lokalisierungsparameter und Optionen des statischen Website-Compilers.

Konfigurations-Schema-Formate

JSON ist das primäre Konfigurationsformat, das eine hochperformante Serialisierung über Worker-Threads hinweg bei parallelen Builds ermöglicht:

{
  "title": "Meine Technische Dokumentation",
  "url": "https://docs.example.com",
  "src": "docs",
  "out": "site",
  "base": "/"
}

Für dynamische Setups, die Umgebungsvariablen oder programmgesteuerte Logik erfordern, werden docmd.config.ts und docmd.config.js vollständig unterstützt:

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

const config: UserConfig = {
  title: process.env.DOCS_TITLE || 'Meine Technische Dokumentation',
  src: 'docs',
  out: 'site'
};

export default config;

module.exports = {
  title: process.env.DOCS_TITLE || 'Meine Technische Dokumentation',
  src: 'docs',
  out: 'site'
};

Kerneinstellungen

Diese Top-Level-Eigenschaften konfigurieren Basispfade und globale Compiler-Optionen:

Branding & Identität

Konfigurieren Sie Marken-Logos und Browser-Favicons in docmd.config.json:

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

UI-Layout und Verhalten

Konfigurieren Sie Header, Sidebars, Suchplatzierung und Theme-Umschalter:

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

Weitere Informationen finden Sie im Leitfaden für Layout & UI-Zonen.

Kern-Compiler-Optionen

Feinabstimmung der Analyse und Transformation Ihrer Markdown-Inhalte durch docmd:

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