Skip to content

README.de.md

Latest commit

 

History

History
282 lines (212 loc) · 11.8 KB

README.de.md

File metadata and controls

282 lines (212 loc) · 11.8 KB
EN  |  ES  |  DE  |  日本語  |  FR  |  中文
docmd

Produktionsreife Dokumentation aus Markdown, in Sekunden.
Zero Config. AI-nativ. Für Entwickler gebaut.

npm version monatliche Downloads GitHub-Sterne Lizenz

Website  ·  Dokumentation  ·  Live-Editor  ·  Agent Skills  ·  Bug melden


docmd Standard-Theme — Vorschau Light- und Dark-Mode



Schnellstart

Starten Sie docmd in jedem Ordner mit Markdown-Dateien — keine Installation nötig:

npx @docmd/core dev
Öffnet unter http://localhost:3000
    _                 _
  _| |___ ___ _____ _| |
 | . | . |  _|     | . |
 |___|___|___|_|_|_|___|

 v1.x.x

┌─ Build
│  Engine          JS
│  Source          docs/
│  Output          site/
│  Versions        2 (06, 05)
│  Locales         7 (en, hi, zh, es, de, ja, fr)
└──────────────────────────────────────────────────────────
┌─ Data Indexing
│  [ DONE ] Syncing git metadata
│  [ DONE ] Building semantic search index (multi-version)
└──────────────────────────────────────────────────────────
┌─ Publishing
│  [ DONE ] Generated robots.txt
│  [ DONE ] Generated .nojekyll (disables Jekyll on GitHub Pages)
│  [ DONE ] Generated sitemap
│  [ DONE ] Generating LLMs context files
└──────────────────────────────────────────────────────────

⬢ Initial build completed in 1.2s.

┌─ Watching
│  Source          ./docs
│  Config          ./docmd.config.json
│  Assets          ./assets
└──────────────────────────────────────────────────────────
┌─ Development Server Running
│  Local Access    http://127.0.0.1:3000
│  Network Access  http://192.168.1.6:3000
│  Serving from    ./site
└──────────────────────────────────────────────────────────

docmd Dev-Server Vorschau

Die Navigation wird aus Ihrer Verzeichnisstruktur generiert. Keine Config-Datei, kein Frontmatter nötig, kein Framework zu lernen.

Wenn Sie bereit zum Veröffentlichen sind:

npx @docmd/core build

Dies erzeugt eine hochoptimierte statische Site (SPA), bereit für das Deployment zu Vercel, Cloudflare Pages, Netlify, GitHub Pages oder jedem beliebigen Static Host.

Anforderungen: Node.js 18+

Oder global installieren / per Docker
# Global via npm installieren
npm install -g @docmd/core

# Oder via pnpm
pnpm add -g @docmd/core

# Ausführen
docmd dev    # Dev-Server starten
docmd build  # Für Deployment bauen

Oder per Docker:

docker run -p 3000:3000 ghcr.io/docmd-io/docmd:0.8.7

Versionieren Sie für reproduzierbare Builds.

Warum docmd?

Feature docmd Docusaurus MkDocs VitePress Mintlify
Config erforderlich Keine docusaurus.config.js mkdocs.yml config.mts docs.json
JS-Payload ~18 kb ~250 kb ~40 kb ~50 kb ~120 kb
Navigation Sofortige SPA React SPA Vollständiger Reload Vue SPA Gehostete SPA
Versionierung Nativ Nativ (komplex) mike-Plugin Manuell Nativ
i18n Nativ Nativ (komplex) Plugin-basiert Nativ Nativ
Multi-Projekt Nativ Plugin Plugin - -
Suche Eingebaut Algolia (Cloud) Eingebaut MiniSearch Cloud
AI-Kontext (llms.txt) Eingebaut - - - Eingebaut
MCP-Server Eingebaut - - - Eingebaut
Agent Skills Eingebaut - - - -
Docker-Image Offiziell - Offiziell - -
Self-hosted Ja Ja Ja Ja -
Kosten Frei (OSS) Frei (OSS) Frei (OSS) Frei (OSS) Freemium

Features

Zero Config, sofortiger Start

Zeigen Sie docmd auf einen beliebigen Markdown-Ordner und es läuft. Die Navigation wird automatisch aus Ihrer Verzeichnisstruktur erstellt. Sie können Ihre erste Doku schreiben und in unter einer Minute live haben — kein Boilerplate, keine zu konfigurierende Build-Pipeline, keine Vorab-Entscheidungen.

Winzig standardmäßig, schnell überall

Der Standard-JavaScript-Payload ist ~18 kb. Seiten navigieren als sofortige SPA. Die Ausgabe ist statisches HTML — SEO-optimiert, mit Sitemap, kanonischen URLs und Open-Graph-Metadaten. Offline-Volltextsuche ist eingebaut, kein Cloud-Dienst nötig.

AI-nativ

docmd ist für die Art gebaut, wie Dokumentation heute gelesen und genutzt wird:

  • MCP-Server — docmd mcp stellt Ihre Doku AI-Agenten über stdio zur Verfügung, damit diese direkt suchen, lesen und Inhalte validieren können.
  • Kontext (llms.txt / llms-full.txt) — vollständiger Dokumentations-Kontext, zur Build-Zeit generiert, bereit für jedes LLM.
  • Agent Skills — modulare Anleitungs-Sets für LLMs und IDE-Agenten (docmd-skills).
  • Als Markdown kopieren / Kontext kopieren — Ein-Klick-Buttons im Browser, optimiert zum Einfügen in AI-Chats.

Auf Skalierung ausgelegt

  • Internationalisierung mit Multi-Locale-Builds
  • Versionierung für mehrere Dokumentations-Releases
  • Workspaces für Monorepos und Multi-Projekt-Setups
  • Plugin-System zur Erweiterung der Kern-Funktionalität
  • Volle Theming-Unterstützung, eingebaute Templates, eigenes CSS/JS, Light/Dark-Mode

CLI

docmd dev            # lokaler Dev-Server
docmd build          # Für Deployment bauen
docmd live           # Browser-basierter Live-Editor
docmd migrate        # Import aus Docusaurus, VitePress, MkDocs oder Starlight
docmd deploy         # Config für Docker, NGINX, Caddy, Vercel, Netlify generieren
docmd validate       # Alle internen Links prüfen
docmd mcp            # Als MCP-Server über stdio betreiben
docmd add <name>     # Plugin oder Template installieren

Plugins

Die Kern-Funktionalität wird von einem robusten Plugin-System bereitgestellt. Die Grundlagen sind standardmäßig enthalten, optionale Plugins können für spezifische Bedürfnisse hinzugefügt werden.

Plugin Status Beschreibung
search ✅ Kern Offline-Volltextsuche mit Fuzzy-Matching
seo ✅ Kern SEO-Tags und Open-Graph-Metadaten
sitemap ✅ Kern Generiert sitemap.xml
git ✅ Kern Git-Commit-Historie und letzte Aktualisierungsdaten
analytics ✅ Kern Schlanke Analytics-Integration
llms ✅ Kern AI-Kontext-Generierung (llms.txt / llms-full.txt)
mermaid ✅ Kern Mermaid-Diagramm-Unterstützung
openapi ✅ Kern Build-Time-OpenAPI-3.x-Spec-Renderer
pwa ➕ Optional Progressive Web App — Offline-Navigation
threads ➕ Optional Inline-Diskussions-Threads (von @svallory)
math ➕ Optional KaTeX / LaTeX-Mathematik-Rendering

Optionale Plugins installieren:

docmd add <plugin-name>

Eigene bauen: Plugin-Entwicklungs-Leitfaden

Konfiguration

Keine Konfiguration ist nötig, um zu starten. Fügen Sie eine docmd.config.json (oder .ts / .js) im Projektstamm nur dann hinzu, wenn Sie mehr Kontrolle brauchen:

{
  "title": "Mein Projekt",
  "url": "https://docs.meinprojekt.de",
  "src": "./docs",
  "out": "./dist"
}

TypeScript- und JavaScript-Konfigurationsdateien werden für dynamische Werte unterstützt.

Vollständige Referenz: Konfigurations-Übersicht

Projektstruktur

my-docs/
├── docs/                ← Ihre Markdown-Dateien
├── assets/              ← Bilder und statische Dateien
├── docmd.config.json    ← Optionale Konfiguration
└── package.json

Live-Editor

Ein browserbasierter Editor zum Schreiben und Vorschauen von Doku — kein lokales Setup erforderlich.

docmd Live-Editor Vorschau

Probieren Sie es aus auf live.docmd.io

Programmatische API

Verwenden Sie docmd in Node.js-Skripten, CI-Pipelines oder benutzerdefinierten Build-Schritten. (Unterstützt sowohl CommonJS als auch ESM.)

import { build } from '@docmd/core';

await build('./docmd.config.json', { isDev: false });

Vollständige Referenz: Node-API

Community

Unterstützung

  • docmd bekannt zu machen ist der direkteste Weg, seine Entwicklung zu unterstützen. Teilen Sie es auf X mit Freunden oder geben Sie ihm einen Stern.
  • Falls docmd Ihnen Zeit spart, hilft ein GitHub-Sponsoring sehr weiter.
  • Ideen oder Bugs? Eröffnen Sie ein Issue oder eine PR, gerne auch mit eigenen Plugins.

Lizenz

MIT — siehe LICENSE für Details.