Wählen Sie die Installationsmethode, die zu Ihrem Workflow passt. Für lokale Builds ist Node.js 18 oder höher erforderlich.
1. Lokale Installation (empfohlen)
docmd lokal auszuführen hält Ihre Dokumentationskonfiguration mit Ihrem Quellcode versioniert.
# Als Entwicklungsabhängigkeit installieren
npm install -D @docmd/core
# Neues Projekt initialisieren
npx docmd init
# Als Entwicklungsabhängigkeit installieren
pnpm add -D @docmd/core
# Neues Projekt initialisieren
pnpm dlx docmd init
# Als Entwicklungsabhängigkeit installieren
yarn add -D @docmd/core
# Neues Projekt initialisieren
yarn dlx docmd init
# Als Entwicklungsabhängigkeit installieren
bun add -D @docmd/core
# Neues Projekt initialisieren
bunx docmd init
# Offizielles Multi-Architektur-Image ziehen
docker pull ghcr.io/docmd-io/docmd:latest
# Dokumentation aus lokalem docs/ nach site/ bauen
docker run -v $(pwd)/docs:/docs -v $(pwd)/site:/site ghcr.io/docmd-io/docmd:latest build
Docker-Compose- und Kubernetes-Konfigurationen finden Sie im Docker-Bereitstellungs-Leitfaden.
<img width=“500” class=“with-border” src=“/assets/previews/terminal-npx-init.webp”>
Nach der lokalen Installation können Sie npx docmd dev verwenden, um den Live-Vorschauserver zu starten, oder Skripte direkt zu Ihrer package.json hinzufügen.
2. Globale Installation
Installieren Sie das Paket global, um Sites überall auf Ihrem System 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 das docmd-Binary überall verfügbar:
docmd dev # Dev-Server lokal starten
docmd build # Statische Ausgabe erzeugen
3. Reine Browser-Integration
Binden Sie die Engine direkt über CDN in eine bestehende Webanwendung 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 Ihrer HTML das Stylesheet und die JavaScript-Engine hinzu.
<!-- Kern-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/public/docmd-live.js"></script>
Vollständige Integrationsdetails finden Sie im Browser-API-Leitfaden.
4. Fehlerbehebung
Berechtigung verweigert (EACCES-Fehler)
Verwenden Sie sudo für globale Installationen auf macOS oder Linux nicht. Beheben Sie Berechtigungskonflikte mit einem Node.js-Versionsmanager wie nvm oder fnm.
PowerShell-Ausführungsrichtlinien (Windows)
Falls Windows die Ausführung blockiert, öffnen Sie PowerShell als Administrator und aktivieren Sie die Skriptausführung für den aktuellen Benutzer.
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser