Wählen Sie die Installationsmethode, die zu Ihrem Workflow passt. Node.js 18 oder höher ist für lokale Builds erforderlich.
1. Lokale Installation (empfohlen)
Die lokale Ausführung von docmd hält Ihre Dokumentationskonfiguration mit Ihrem Quellcode versioniert.
# Als Entwicklungsabhängigkeit installieren
npm install -D @docmd/core
# Ein neues Projekt initialisieren
npx docmd init
# Als Entwicklungsabhängigkeit installieren
pnpm add -D @docmd/core
# Ein neues Projekt initialisieren
pnpm dlx docmd init
# Als Entwicklungsabhängigkeit installieren
yarn add -D @docmd/core
# Ein neues Projekt initialisieren
yarn dlx docmd init
# Als Entwicklungsabhängigkeit installieren
bun add -D @docmd/core
# Ein neues Projekt initialisieren
bunx docmd init
# Ziehen Sie das offizielle Multi-Architektur-Image
docker pull ghcr.io/docmd-io/docmd:latest
# Dokumentation von lokalem docs/ nach site/ erstellen
docker run -v $(pwd)/docs:/docs -v $(pwd)/site:/site ghcr.io/docmd-io/docmd:latest build
Siehe Leitfaden zur Docker-Bereitstellung für Docker Compose und Kubernetes-Konfigurationen.
Nach der lokalen Installation können Sie npx docmd dev verwenden, um den Live-Vorschau-Server zu starten, oder Skripte direkt zu Ihrer package.json hinzufügen.
2. Globale Installation
Installieren Sie das Paket global, um überall auf Ihrem System Websites zu erstellen oder in der Vorschau anzuzeigen, ohne ein lokales Projekt anzulegen.
npm install -g @docmd/core
pnpm add -g @docmd/core
yarn global add @docmd/core
bun add -g @docmd/core
Nach der Installation ist die docmd-Binärdatei überall verfügbar:
docmd dev # Lokalen Entwicklungsserver starten
docmd build # Statische Ausgabe erstellen
3. Nur-Browser-Integration
Betten Sie die Engine direkt über ein CDN in eine bestehende Web-Anwendung ein.
Dies umgeht die CLI und lädt die Parsing-Engine im Browser des Lesers. Verwenden Sie dies für dynamische Portale, nicht für statische SEO-Websites.
Fügen Sie das Stylesheet und die JavaScript-Engine zu Ihrem HTML hinzu.
<!-- Haupt-Stylesheet -->
<link rel="stylesheet" href="https://unpkg.com/@docmd/ui/assets/css/docmd-main.css">
<!-- Isomorphe Rendering-Engine -->
<script src="https://unpkg.com/@docmd/live/dist/docmd-live.js"></script>
Siehe Leitfaden zur Browser-API für vollständige Integrationsdetails.
4. Fehlerbehebung
Berechtigung verweigert (EACCES-Fehler)
Verwenden Sie nicht sudo für globale Installationen unter macOS oder Linux. Beheben Sie Berechtigungskonflikte mit einem Node.js-Versionsmanager wie nvm oder fnm.
PowerShell-Ausführungsrichtlinien (Windows)
Wenn Windows die Ausführung blockiert, öffnen Sie PowerShell als Administrator und aktivieren Sie die Ausführung von Skripten für den aktuellen Benutzer.
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser