Erstellen und veröffentlichen Sie mehrere Dokumentationsprojekte aus einem einzigen Repository. Jedes Projekt behält seine eigene Konfiguration, Versionierung und Navigation, während es ein gemeinsames Theme und eine gemeinsame Asset-Pipeline nutzt.

Übersicht

Der Multi-Projekt-Modus ist für Organisationen konzipiert, die mehrere Tools, Bibliotheken oder Produkte unter einer Domain pflegen. Statt mehrere docmd-Instanzen hinter einem Reverse-Proxy zu betreiben, erzeugt ein einzelnes docmd build ein einheitliches site/-Verzeichnis.

docs.example.com/           → Hauptdokumentation
docs.example.com/sdk/       → SDK-Referenz
docs.example.com/cli/       → CLI-Dokumentation

Einrichtung

1. Verzeichnisstruktur

Organisieren Sie Ihr Repository mit einem Verzeichnis pro Projekt:

my-docs/
├── assets/                   ← gemeinsame Assets (alle Projekte)
├── main-docs/
│   ├── docmd.config.js       ← Projektkonfiguration
│   └── v01/                  ← versionierte Inhalte
│       └── en/
├── sdk-docs/
│   ├── docmd.config.js       ← Projektkonfiguration
│   └── docs/                 ← nicht-versionierte Inhalte
├── docmd.config.js           ← Root-Multi-Projekt-Konfiguration
└── package.json

2. Root-Konfiguration

Die Root-docmd.config.js enthält nur das projects-Array:

module.exports = defineConfig({
  projects: [
    { prefix: '/', src: 'main-docs' },
    { prefix: '/sdk', src: 'sdk-docs' }
  ]
});

3. Projektkonfigurationen

Jedes Projektverzeichnis hat seine eigene docmd.config.js mit vollständig unabhängiger Konfiguration. Fügen Sie keine src- oder out-Schlüssel ein — die übergeordnete Konfiguration stellt diese automatisch bereit.

Jedes Projekt kann vollständig unabhängige Einstellungen haben:

• i18n — verschiedene Sprachen, verschiedene Standardsprachen
• Versionierung — unterschiedliche Versionsnummern und Strukturen
• Plugins — nur aktivieren, was jedes Projekt benötigt
• Navigation — individuelle Seitenleiste für jedes Projekt

Assets

Gemeinsame Assets

Legen Sie gemeinsame Ressourcen (Logos, Favicons, globales CSS) im Root-assets/-Verzeichnis ab. Diese werden automatisch in die Ausgabe jedes Projekts kopiert.

Projektspezifische Assets

Jedes Projekt kann ein eigenes assets/-Verzeichnis haben. Projektspezifische Assets haben Vorrang vor gemeinsamen Assets bei Namenskonflikten.

my-docs/
├── assets/
│   └── images/
│       └── logo.png          ← von allen Projekten verwendet
├── sdk-docs/
│   └── assets/
│       └── images/
│           └── logo.png      ← überschreibt Logo nur für SDK

Entwicklung

Starten Sie den Multi-Projekt-Entwicklungsserver:

docmd dev

Der Server erstellt alle Projekte und stellt sie über einen einzigen Port bereit:

┌─ DEV SERVER
│
│  Local           http://127.0.0.1:3000
│  Network         http://192.168.1.5:3000
│
│  Project         http://127.0.0.1:3000/
│  Project         http://127.0.0.1:3000/sdk
└──────────────────────────────────────────────────────────

Dateiänderungen in einem Projekt lösen einen gezielten Neubau mit Live-Reload aus. Nur das betroffene Projekt wird neu erstellt — andere Projekte bleiben für schnelle Iteration unberührt. Änderungen an gemeinsamen Assets erstellen alle Projekte neu.

Erstellen & Bereitstellen

docmd build

Die Ausgabe ist ein einzelnes statisches Verzeichnis:

site/
├── index.html              ← main-docs Root
├── sdk/
│   └── index.html          ← sdk-docs Root
├── assets/                 ← zusammengeführte Assets
├── 404.html
└── sitemap.xml

Veröffentlichen Sie es auf jedem statischen Hosting (GitHub Pages, Netlify, Vercel, Cloudflare Pages) ohne zusätzliche Konfiguration. Keine nginx- oder Proxy-Regeln erforderlich.

Regeln & Einschränkungen

1. Root-Projekt erforderlich — ein Projekt muss prefix: '/' haben
2. Keine doppelten Präfixe — jedes Projekt benötigt ein einzigartiges URL-Präfix
3. Kein src/out in untergeordneten Konfigurationen — die übergeordnete Konfiguration stellt diese bereit
4. Alles unabhängig — jedes Projekt hat eigene Titel, Versionen, i18n, Plugins und Navigation
5. Root-Konfiguration minimal — nur projects sollte in der Root-docmd.config.js stehen