Skip to content

README.de.md

Latest commit

 

History

History
276 lines (204 loc) · 9.88 KB

README.de.md

File metadata and controls

276 lines (204 loc) · 9.88 KB
EN  |  ES  |  DE  |  日本語  |  FR  |  中文

docmd logo

Erstellen Sie in Sekundenschnelle produktionsreife Dokumentationen aus Markdown.
AI-First & Zero-Config Dokumentations-Engine für Entwickler und LLM-Agenten.

npm version downloads stars license

Website • Dokumentation • Live-Editor • Agent Skills • Fehler melden


docmd preview
docmd `default` Theme - Vorschau im Hell- und Dunkelmodus

Schnelleinstieg

Führen Sie docmd sofort in jedem Ordner mit Markdown-Dateien aus:

npx @docmd/core dev

Startet unter: http://localhost:3000

Das ist alles.

  • Die Navigation wird automatisch generiert
  • Seiten werden sofort gerendert
  • Ihre Dokumente sind standardmäßig bereit für den Produktiveinsatz

Erstellen Sie Ihre Website:

npx @docmd/core build

Installation für den regelmäßigen Gebrauch

npm install -g @docmd/core

Oder über Docker ausführen:

docker run -p 3000:3000 ghcr.io/docmd-io/docmd:latest
docmd dev     # Entwicklungsserver starten
docmd build   # Build für die Bereitstellung erstellen
docmd migrate # Von anderen Dokumentationswerkzeugen migrieren (wie Docusaurus, VitePress, MkDocs, etc.)
docmd deploy  # Docker-, Nginx- oder Caddy-Konfig. generieren

Funktionen

Entwickelt, um sofort zu starten und ohne Reibungsverluste zu skalieren.

Standardmäßig sofort einsatzbereit

  • Automatische Navigation basierend auf Ihren Dateien
  • Keine Konfiguration erforderlich
  • Funktioniert direkt mit Markdown

Produktionsreife Ausgabe

  • Statische HTML-Generierung
  • SEO-optimiert (Sitemap, Canonical, Weiterleitungen)
  • Winziger JavaScript-Payload

Integrierte Funktionen

  • Internationalisierung (i18n)
  • Versionierung
  • Offline-Suche
  • PWA-Unterstützung
  • Analytik
  • KI-Kontext (llms.txt)

KI-First-Integration

  • Nativer MCP-Server (docmd mcp) — KI-Agenten suchen, lesen und validieren Docs über stdio
  • Agent-Skill-Set (docmd-skills) — modulare Skills für LLMs und IDE-Agenten
  • llms.txt / llms-full.txt — vollständiger Dokumentationskontext zur Build-Zeit generiert
  • Markdown/Kontext kopieren — Browser-Buttons optimiert für KI-Chat

Bei Bedarf erweiterbar

  • Plugin-Unterstützung
  • Eigene Konfiguration und Navigation
  • Theming
  • Programmatische API

Sehen Sie sich die vollständige Roadmap an.

Projektstruktur

Hält Ihr Projekt einfach.

my-docs/
├── docs/
├── assets/
├── docmd.config.json (optional)
└── package.json

Live-Editor

Ein browserbasierter Editor zum sofortigen Schreiben und Vorschauen von Dokumenten. Kein Setup erforderlich.

Probieren Sie es aus: live.docmd.io

Konfiguration (optional)

Für den Anfang ist keine Konfiguration erforderlich.

Fügen Sie eine Konfigurationsdatei (docmd.config.json im Projektwurzelverzeichnis) nur hinzu, wenn Sie mehr Kontrolle benötigen.

const { defineConfig } = require('@docmd/core');

module.exports = defineConfig({
  title: 'Mein Projekt',
  url: 'https://docs.meinprojekt.de',
});

Gemeinsame Optionen

module.exports = defineConfig({
  // Versionierung
  versions: {
    current: 'v2',
    all: [
      { id: 'v2', dir: 'docs' },
      { id: 'v1', dir: 'docs-v1' }
    ]
  },

  // Internationalisierung
  i18n: {
    default: 'en',
    locales: [
      { id: 'en', label: 'English' },
      { id: 'zh', label: '中文' },
    ]
  }
});

Integrierte Unterstützung für: Englisch, Hindi, Chinesisch, Spanisch, Deutsch, Japanisch und Französisch. Sie können ganz einfach jede andere Sprache hinzufügen und unterstützen.

Andere gängige Einstellungen sind src, out, Navigation, Plugins und Theming.

Programmatische Verwendung

Verwendung in Skripten oder CI-Pipelines:

const { build, buildLive } = require('@docmd/core');

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

Benötigen Sie mehr?

Vollständige Konfiguration, Plugins und fortgeschrittene Nutzung: docs.docmd.io

Plugin-Ökosystem

Kernfunktionen sind standardmäßig enthalten.

Alles funktioniert out-of-the-box.

Plugins werden nur benötigt, wenn Sie die Funktionalität erweitern möchten.

Plugin Enthalten Beschreibung
search ✓ Offline-Volltextsuche mit Fuzzy-Matching
seo ✓ SEO-Tags und Open-Graph-Metadaten
sitemap ✓ Generiert sitemap.xml
git ✓ Git-Commit-Historie Logger
analytics ✓ Leichtgewichtige Analytik-Integration
llms ✓ KI-Kontextgenerierung (llms.txt)
mermaid ✓ Mermaid-Diagramme in Markdown
openapi ✓ OpenAPI 3.x-Spezifikations-Renderer zur Build-Zeit
pwa Optional PWA-Unterstützung für Offline-Navigation
threads Optional Inline-Diskussions-Threads (von @svallory)
math Optional KaTeX/LaTeX-Mathe-Rendering

Optionale Plugins installieren:

docmd add <plugin-name>

Warum docmd?

Merkmal docmd Docusaurus MkDocs Material VitePress Mintlify
Sprache Node.js React.js Python Vue SaaS
Konfig. erf. Keine docusaurus.config.js mkdocs.yml config.mts mint.json
Multi-Projekt Nativ Plugin Plugin Nein Nein
Start-Payload ~18kb ~250kb ~40kb ~50kb ~120kb
Navigation Instant SPA React SPA Vollständiger Reload Vue SPA Gehostete SPA
Versionierung Eingebaut Nativ (komplex) mike Plugin Manuell Nativ
i18n Eingebaut Nativ (komplex) Plugin-basiert Manuell Nativ
Suche Eingebaut (offline) Algolia (Cloud) Eingebaut MiniSearch Cloud
KI-Kontext Eingebaut (llms.txt) Keiner Keiner Keiner Eingebaut
MCP-Server Eingebaut Keiner Keiner Keiner Eingebaut
Agent Skills Eingebaut Keine Keine Keine Eingebaut
Docker-Image Offiziell Keines Offiziell Keines N/A
PWA Offizielles Plugin Community-Plugin Keines Keines Gehostet
Self-hosted Ja Ja Ja Ja Nein
Kosten Kostenlos (OSS) Kostenlos (OSS) Kostenlos (OSS) Kostenlos (OSS) Freemium

Fängt einfach an. Skaliert ohne Reibungsverluste.

Philosophie

Dokumentationstools sollten verschwinden.

Fokus auf das Schreiben, nicht auf das Setup.

Kein Konfigurationsaufwand. Keine Komplexität durch Frameworks. Nur Dokumentation.

Gemeinschaft & Support

  • Beiträge sind willkommen. Siehe CONTRIBUTING.md
  • Wenn Sie es nützlich finden, ziehen Sie ein Sponsoring in Betracht oder geben Sie dem Repo ein ⭐

Lizenz

MIT-Lizenz. Siehe LICENSE für Details.