Docsbook
Übersicht

Dokumentation aus einem GitHub-Repository bereitstellen

Sie haben Markdown-Dateien in einem GitHub-Repository. Sie möchten, dass sie unter einer echten URL verfügbar sind – durchsuchbar, mit Ihrem Branding versehen, von Google indexiert und auf Mobilgeräten lesbar. Das Repository ist die maßgebliche Quelle; die Website ist die Oberfläche.

Es gibt drei gängige Wege dorthin. Dieses Tutorial führt Sie durch jeden einzelnen, einschließlich der konkreten Einrichtungsschritte und Abwägungen.

Was haben Sie bereits?#

Ein typisches Dokumentations-Repository sieht so aus:

my-product/
├── README.md
├── docs/
│   ├── getting-started.md
│   ├── api-reference.md
│   └── guides/
│       └── webhooks.md

Sie möchten daraus eine Website machen. Die drei realistischen Optionen sind:

  1. GitHub Pages — kostenlos, unverfälscht, manuell
  2. Docusaurus — code-lastig, selbst gehostet, bis hin zur Theme-Komponente anpassbar
  3. Docsbook — sofort verfügbar, verwaltet, URL einfügen

Option 1: GitHub Pages mit Jekyll#

GitHub Pages stellt statische Websites kostenlos aus einem Repository-Zweig bereit. Mit einem _config.yml erkennt es Jekyll und rendert dein Markdown.

Schritte#

  1. Erstellen Sie _config.yml im Stammverzeichnis des Repositorys: 
    theme: jekyll-theme-minimal
title: My Product Docs
  2. Gehen Sie in Ihrem Repository zu Einstellungen → Seiten
  3. Legen Sie als Quelle den main-Branch und den /docs-Ordner fest
  4. Warten Sie einige Minuten – Ihre Website ist unter username.github.io/repo verfügbar

Was Sie erhalten#

  • Eine funktionierende URL
  • Grundlegendes Theme
  • Kostenloses Hosting

Was fehlt#

  • Keine Suche
  • Keine Navigationsseitenleiste ohne manuelle Konfiguration
  • Keine Analysen
  • Jekyll-Themes sehen aus wie aus dem Jahr 2014
  • Eine benutzerdefinierte Domain funktioniert, aber DNS und SSL richtest du selbst ein
  • Keine KI-Funktionen, keine Übersetzungen, keine SEO-Funktionen von Haus aus

Gut für ein internes Wiki. Nicht gut, wenn deine Dokumentation eine kundenorientierte Produktoberfläche ist.

Option 2: Docusaurus#

Docusaurus ist Metas Open-Source-Dokumentationsframework. Es basiert auf React und lässt sich bis hin zu einzelnen Komponenten thematisieren – sofern Sie bereit sind, es zu warten.

Schritte#

  1. Node.js 18+ lokal installieren
  2. Das Projektgerüst erstellen: 
    npx create-docusaurus@latest my-docs classic
cd my-docs
  3. Verschiebe deine vorhandenen Markdown-Dateien in den Ordner docs/, den Docusaurus erstellt hat
  4. Bearbeite docusaurus.config.js — lege den Seitentitel, die Basis-URL, die Seitenleistenstruktur, die Theme-Farben und die Elemente der Navigationsleiste fest
  5. Bearbeite sidebars.js — lege fest, welche Dateien in welcher Reihenfolge angezeigt werden
  6. Führe npm run start aus, um eine lokale Vorschau anzuzeigen
  7. Erstellen: npm run build
  8. Auf Vercel, Netlify oder GitHub Pages bereitstellen — die Bereitstellungspipeline, Umgebungsvariablen und Build-Befehle einrichten
  9. Eine benutzerdefinierte Domain konfigurieren — DNS verweisen und auf die SSL-Bereitstellung warten
  10. Analytics hinzufügen — Plausible, GA oder ein Tool deiner Wahl manuell integrieren
  11. Eine Suche hinzufügen — für Algolia DocSearch bezahlen (oder Meilisearch selbst hosten)
  12. Bei jeder Produktveröffentlichung alles aktualisieren

Was Sie erhalten#

  • Volle Kontrolle über Design und Struktur
  • Eine React-Codebasis, die Sie erweitern können
  • Eine langfristig bestehende Open-Source-Community

Was fehlt#

  • Zeit. Die eigentliche Einrichtung ist ein 2–3-tägiges Projekt, danach fortlaufende Wartung bei jeder Aktualisierung einer Abhängigkeit
  • KI-Suche, KI-Chat, KI-Übersetzung – nicht enthalten
  • Sie verwalten jede einzelne Konfigurationszeile selbst

Gut, wenn die Dokumentation selbst ein Produkt ist, das Ihr Team besitzt und ausliefert. Schmerzhaft, wenn Sie einfach nur Ihre Dokumentation online stellen möchten.

Option 3: Docsbook#

Docsbook ist eine verwaltete Plattform, die ein GitHub-Repository sofort in eine Dokumentationswebsite verwandelt. Keine CI/CD, keine Konfigurationsdateien, keine Build-Pipeline.

Schritte#

  1. Gehe zu docsbook.io
  2. Melde dich mit GitHub an
  3. Füge die URL deines Repositories ein (z. B. github.com/your-org/your-repo)
  4. Fertig – deine Website ist unter docsbook.io/your-org/your-repo live

Das war's. Jeder git push an main aktualisiert die Website automatisch.

Was Sie standardmäßig erhalten#

  • KI-Chatbot, der mit Ihrer Dokumentation trainiert wurde, damit Nutzer Antworten statt Suchergebnisse erhalten
  • KI-Übersetzung in 15 Sprachen, die jeweils separat von Google indexiert werden
  • Individuelle Domain wie docs.yourcompany.com mit kostenlosem SSL
  • SEO — Meta-Tags, Sitemap, OpenGraph, JSON-LD, alles automatisch
  • llms.txt, generiert für KI-Suchmaschinen (ChatGPT, Perplexity, Claude)
  • Analysen — Seitenaufrufe, meistbesuchte Seiten, Verweise, gestellte KI-Fragen
  • Markenanpassung — Logo, Farben, Schriftarten, Theme — ohne den Code anzufassen
  • MCP-Server, damit KI-Agenten Ihre Dokumentation programmgesteuert lesen und verwalten können

Was fehlt#

  • Ihnen gehört nicht die Rendering-Pipeline – aber Ihr Markdown bleibt in Ihrem Repository, sodass Sie nicht gebunden sind. Kündigen Sie jederzeit, und Ihre Dokumentation kommt mit.

Welche Option sollten Sie wählen?#

Anwendungsfall Wahl
Persönliches Projekt, internes Wiki GitHub Pages
Sie haben ein Frontend-Team und eigene Designvorstellungen Docusaurus
Sie möchten, dass Ihre Dokumentation heute Nachmittag online und für SEO optimiert ist Docsbook

Die ehrliche Antwort: Wenn Dokumentation nicht Ihr Produkt ist, sollten Sie keine Dokumentationsplattform entwickeln. Verwenden Sie eine.

Jetzt ausprobieren#

Das Hosten von Dokumentationen auf GitHub bedeutete früher ein Konfigurations-Repository, eine Deployment-Pipeline und regelmäßige Aufräumarbeiten. Fügen Sie die URL Ihres Repositorys ein, und die Website ist live. Das Markdown verlässt das Repository nie, sodass der Vorgang rückgängig gemacht werden kann.

Kostenlos starten – keine Kreditkarte

Nächste Schritte#

Updated

War diese Seite hilfreich?

Powered by Docsbook