Installation
Wählen Sie die Installationsmethode, die am besten zu Ihrem Workflow passt.
Sofort ausführen
npm
Bun
npx @docmd/core dev
bunx @docmd/core dev
Keine Installation erforderlich. Führt docmd direkt in jedem Ordner mit Markdown-Dateien aus.
npm
Bun
# Eine produktionsreife statische Website erstellen
npx @docmd/core build
# Eine produktionsreife statische Website erstellen
bunx @docmd/core build
Als Projektabhängigkeit installieren (empfohlen)
npm
pnpm
yarn
Bun
npm install -D @docmd/core
npx @docmd/core init
npx @docmd/core dev
pnpm add -D @docmd/core
pnpm dlx docmd init
pnpm dlx docmd dev
yarn add -D @docmd/core
yarn docmd init
yarn docmd dev
bun add -D @docmd/core
bunx docmd init
bunx docmd dev
Dies fixiert die Version für Ihr gesamtes Team und Ihre CI/CD-Pipeline.
Nach der lokalen Installation
Sobald @docmd/core eine Projektabhängigkeit ist, verwenden Sie npx @docmd/core anstelle von npx @docmd/core für alle Befehle.
Global installieren
npm
pnpm
yarn
Bun
npm install -g @docmd/core
pnpm add -g @docmd/core
yarn global add @docmd/core
bun add -g @docmd/core
# Den 'docmd'-Befehl überall verwenden
docmd dev
docmd build
Nur-Browser-Integration
Nur für Bibliotheksnutzung
Diese Methode bettet die docmd-Rendering-Engine in eine andere Webanwendung ein. Dies ist nicht der Standardweg zum Erstellen von Dokumentationsseiten.
<!-- Kern-Styles -->
<link rel="stylesheet" href="https://unpkg.com/@docmd/ui/assets/css/docmd-main.css">
<!-- Processing-Engine -->
<script src="https://unpkg.com/@docmd/live/dist/docmd-live.js"></script>
Weitere Details zur Integration finden Sie im Browser-API-Leitfaden.
Fehlerbehebung
Berechtigung verweigert (EACCES)
PowerShell-Skriptausführung (Windows)
Wenn PowerShell die Skriptausführung blockiert, führen Sie dies als Administrator aus:
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser