Setup
Für Mitwirkende an der Dokumentations-Site. Möchten Sie zu docmd selbst (dem Framework) beitragen? Sehen Sie stattdessen den GitHub-Contributing-Leitfaden an — dort befindet sich der Framework-Entwicklungs-Workflow.
Diese Seite behandelt die Arbeit an dieser Dokumentations-Site (docmd-io/docs), nicht am docmd-Framework (docmd-io/docmd).
Voraussetzungen
- Node.js: v22.x oder neuer (LTS empfohlen)
- pnpm: v10.x oder neuer
Lokale Entwicklung
git clone https://github.com/docmd-io/docs.git
cd docs
pnpm install
npx @docmd/core dev
Die Site wird unter http://localhost:3000 mit Live-Reload ausgeliefert.
Framework lokal beobachten
Wenn Sie Framework-Code in docmd-io/docmd bearbeiten und die Änderungen in dieser Dokumentations-Site sehen möchten:
# Im Framework-Repo
pnpm build
# In diesem Docs-Repo den lokalen Build verknüpfen
npx @docmd/core link ../docmd/packages/core
Starten Sie dann npx @docmd/core dev neu. Ihre Änderungen am Framework werden nach einem Framework-Rebuild übernommen.
Qualitäts-Gates
Bevor Sie einen Pull Request öffnen:
# Markdown linten und auf defekte Links prüfen
pnpm lint
# Vollständige Verifizierungs-Pipeline (Lint + Build + Dead-Link-Check)
pnpm verify
Die Verifizierungs-Pipeline spiegelt, was die Maintainer bei jedem PR ausführen. Ein grüner Durchlauf ist Voraussetzung für einen Merge.
Übersetzungen
Übersetzungs-Workflow zum Hinzufügen/Aktualisieren von de/- und zh/-Inhalten:
- Bearbeiten Sie die EN-Quelle in
docmd-main/v08/en/.... - Spiegeln Sie die Änderung in
de/undzh/(gleicher Pfad, übersetzte Prosa, erhaltene Frontmatter-Schlüssel, erhaltene Container-Marker, Code-Blöcke unverändert). - Behalten Sie alle Datei-Titel in Code-Blöcken (z. B.
```json "docmd.config.json"). - Führen Sie
pnpm verifyaus, um zu bestätigen, dass Links und Struktur weiterhin passen.
Die Übersetzungs-Hausstil-Regeln und die Codeblock-Datei-Titel-Regel finden Sie im Projektspeicher.
Projekt-Layout
docs/
├── docmd-main/v08/
│ ├── en/ # Kanonische englische Quelle
│ ├── de/ # Deutsche Übersetzungen (spiegelt en/)
│ ├── zh/ # Chinesische Übersetzungen (spiegelt en/)
│ └── navigation.json # Eine Navigation, pro Locale repliziert
├── docmd-search/ # Suchindex-Assets
├── docs/ # Andere Doc-Projekte (docmd-search, docmd-main usw.)
└── package.json
Nächste Schritte
- Plugins entwickeln — schreiben Sie ein benutzerdefiniertes docmd-Plugin.
- Plugin-Beispiele — sehen Sie einen vollständigen Plugin-Walkthrough.
- Templates entwickeln — erstellen Sie ein docmd-Template.
- Node-API-Referenz — programmatische Build-API.