Konfigurations- & Benutzerdefinierte Variablen

Konfigurations- & Benutzerdefinierte Variablen

Sie können benutzerdefinierte Variablen direkt in docmd.config.json definieren, aus externen JSON-Dateien oder JavaScript-Modulen laden und in Ihrer gesamten Dokumentation verwenden.

Variablen in docmd.config.json definieren

Fügen Sie Ihrer docmd.config.json einen variables-Block hinzu:

{
  "title": "Acme Cloud Dokumentation",
  "variables": {
    "companyName": "Acme Technologies",
    "supportEmail": "support@acme.com",
    "cloud": {
      "apiEndpoint": "https://api.acme.cloud/v2",
      "region": "eu-central-1",
      "maxInstances": 50
    }
  }
}

Zugriff in Markdown

Verschachtelte Eigenschaften werden mit gewohnter Punktnotation angesprochen:

Unser Support-Team erreichen Sie unter [\{{ supportEmail }}](mailto:\{{ supportEmail }}).

Alle Anfragen richten Sie an unseren Endpunkt:
```bash
curl -X GET \{{ cloud.apiEndpoint }}/status \
  -H "X-Region: \{{ cloud.region }}"

Während des Builds wird dies aufgelöst zu:

```bash
curl -X GET https://api.acme.cloud/v2/status \
  -H "X-Region: eu-central-1"

Variablen in Konfigurationsfeldern nutzen

docmd führt einen einheitlichen Variablen-Pass durch, bevor Layouts, Menüs und Fußzeilen gerendert werden.

Sie können integrierte Variablen wie \{{ docmd.buildYear }} oder \{{ docmd.version }} sowie eigene Werte direkt in Konfigurationsfeldern einsetzen:

{
  "title": "Acme Docs",
  "variables": {
    "companyName": "Acme Cloud Systems"
  },
  "footer": {
    "copyright": "Copyright © \{{ docmd.buildYear }} \{{ companyName }}. Alle Rechte vorbehalten."
  },
  "layout": {
    "banners": {
      "top": {
        "content": "**docmd v\{{ docmd.version }} ist live!** — Region: \{{ env.DEPLOY_REGION || 'global' }}."
      }
    }
  }
}

Externe Variablen-Dateien

Für größere Projekte oder geteilte Teamspezifikationen können Sie "variables" auf externe JSON- oder JavaScript-Dateien verweisen:

{
  "variables": "./data/variables.json"
}

{
  "auth": {
    "oauthUrl": "https://auth.acme.com/oauth2/token",
    "clientId": "acme-portal-production"
  },
  "limits": {
    "rateLimitPerMin": 1200
  }
}

{
  "variables": "./data/variables.js"
}

module.exports = {
  dynamicTimestamp: new Date().toLocaleDateString('de-DE'),
  sdkVersion: require('./package.json').version,
  activeServices: ['auth', 'billing', 'analytics']
};