Docsbook
Übersicht

Verwandle deine README.md in eine echte Dokumentationswebsite

Die Dokumentation deines Projekts befindet sich in README.md. Du wolltest schon immer eine richtige Dokumentationswebsite einrichten. Du hast dir Docusaurus angesehen, den Konfigurationsleitfaden geöffnet und den Tab wieder geschlossen.

Dieser Beitrag ist die Alternative in 5 Sekunden.

Kurzfassung#

  • Die meisten Open-Source-Projekte veröffentlichen ihre Dokumentation ausschließlich als README.md
  • Eine README ist in Ordnung, wird aber bei Google nicht so gut indexiert wie eine echte Dokumentationsseite und bietet keinen KI-Chat, keine Analysen und keine Übersetzungen
  • Docsbook verwandelt ein README.md (und optional docs/) in 5 Sekunden in eine Website unter docsbook.io/yourorg/yourrepo
  • Das Veröffentlichen eines öffentlichen Repositorys kostet nichts. Keine CI/CD-Konfiguration und keine Konfigurationsdateien.

Warum eine README nicht ausreicht#

Drei Verluste bei Projekten, die nur aus einer README bestehen:

1. SEO#

Eine GitHub-README wird indexiert, aber Google rankt github.com/user/repo für den Namen des Repositorys, nicht für technische Suchanfragen. Ein Nutzer, der nach „Authentifizierung mit der X-Bibliothek“ sucht, landet nur selten in der README, selbst wenn die Antwort dort zu finden ist.

Eine echte Dokumentationswebsite unter docs.yourproject.com (oder docsbook.io/yourorg/yourrepo) rankt für die Long-Tail-Suchanfragen, die Ihre README abdeckt, aber nicht sichtbar machen kann.

2. KI-Verbreitung#

ChatGPT und Perplexity zitieren GitHub-READMEs, jedoch inkonsistent. Eine übersichtliche Dokumentationsseite mit llms.txt, strukturierten Überschriften und JSON-LD wird weitaus häufiger zitiert.

Wenn dein Projekt von der Auffindbarkeit durch Entwickler abhängt, sind KI-Zitate inzwischen ein echter Kanal – siehe So werden deine Dokumente von ChatGPT zitiert.

3. UX#

Ein 1.500 Zeilen langes README ist eine einzige endlose Scrollwand. Eine Dokumentationswebsite bietet eine Seitenleiste, eine Suche, Überschriften als Ankerlinks, eine Brotkrümelnavigation und Schaltflächen zum Kopieren von Code. Derselbe Inhalt, aber deutlich besser auffindbar.

Die Einrichtung in 5 Sekunden#

Drei Schritte:

  1. Gehe zu docsbook.io
  2. Melde dich mit GitHub an
  3. Füge github.com/yourorg/yourrepo ein

Die Website ist unter docsbook.io/yourorg/yourrepo live. Deine README erscheint als Startseite. Wenn du einen docs/-Ordner hast, werden diese Seiten in der Seitenleiste angezeigt.

Keine Konfiguration. Kein docsbook.config.js. Keine CI/CD-Pipeline. Keine Bereitstellung.

Was wird indexiert#

Docsbook liest:

  • README.md im Stammverzeichnis des Repositorys → Startseite
  • docs/ Ordner (rekursiv) → Seiten der Website
  • docs/README.md → Docs-Übersichtsseite
  • YAML-Frontmatter (title, description) → Seitenmetadaten

Wenn du nur eine README hast, erhältst du eine einseitige Docs-Website. Wenn du docs/getting-started.md, docs/api.md usw. hast, erhältst du eine mehrseitige Website mit einer Seitenleiste, die aus der Ordnerstruktur erstellt wird.

Frontmatter (optional)#

Füge YAML am Anfang jeder Markdown-Datei hinzu:

---
title: "Quick Start"
description: "Get up and running in 60 seconds"
---
 
# Quick Start
...

title wird zum Seitentitel in Suchmaschinen. description wird zur Meta-Beschreibung. Wenn du beides überspringst, verwendet Docsbook die erste H1 als Titel und den ersten Absatz als Beschreibung.

Was kostet die Veröffentlichung eines OSS-Projekts?#

Die Veröffentlichung der Website kostet nichts, und auch das Lesen ist kostenlos. Abgerechnet wird die KI-Nutzung: Jedes Projekt verfügt über ein eigenes Guthaben, und Fragen an den Assistenten sowie Übersetzungsläufe verbrauchen dieses Guthaben. Die aktuellen Zahlen finden Sie unter docsbook.io/pricing; sie werden bei jeder Anfrage aus den aktuellen Preiskonstanten generiert.

Durch die Veröffentlichung eines Repositorys erhalten Sie:

  • Jedes öffentliche GitHub-Repository als gerenderte Website
  • Individueller Website-Name, individuelles Symbol, Logo und Akzentfarben für helle und dunkle Darstellung
  • Theme-Umschalter, Suche, Breadcrumbs und Schaltflächen zum Kopieren von Code
  • Header-Links und Social-Links (GitHub, Discord, X)
  • Analysen — Seitenaufrufe, meistbesuchte Seiten, Verweisquellen und Länder
  • llms.txt und llms-full.txt für die Auffindbarkeit durch KI
  • Einen MCP-Server, damit Claude Code und Cursor die Dokumentation lesen und bearbeiten können
  • KI-Chat auf Basis von README.md und docs/
  • docs.yourproject.com mit automatischer SSL-Unterstützung

Das Einzige, was Sie nicht deaktivieren können, ist der kleine Link „Powered by Docsbook“ in der Fußzeile der Seite. Er wird ausnahmslos auf jeder Docsbook-Website angezeigt — im Gegenzug dafür, dass Sie das Hosting nicht selbst betreiben müssen.

Wie verwende ich meine eigene Domain anstelle von docsbook.io?#

Verweisen Sie eine Subdomain auf Docsbook, und Ihre Dokumentation wird dort mit automatisch bereitgestelltem SSL ausgeliefert.

  • Dashboard → Einstellungen → Domain
  • DNS: CNAME docs → cname.vercel-dns.com
  • SSL wird automatisch eingerichtet

Eine vollständige Anleitung, einschließlich Apex-Domains und Weiterleitungen: Benutzerdefinierte Domain für Dokumentation.

Was passiert, wenn du einen Push ausführst#

Du pushst einen Commit zu main. Docsbook indiziert die Änderung und aktualisiert die Website. Keine GitHub Action, kein Build-Schritt. Der neue Inhalt ist innerhalb von Sekunden live.

Häufige Fragen#

Funktioniert es für private Repositorys?#

Ja. Docsbook authentifiziert sich über deinen GitHub-OAuth-Bereich, und die veröffentlichte Website kann selbst öffentlich oder privat sein.

Wie steht es um MDX oder interaktive Demos?#

Docsbook setzt auf Markdown. Für interaktive Demos hosten Sie die Demo an einem anderen Ort und verlinken darauf. Wenn Ihr Projekt in Dokumentationsseiten eingebettete React-Komponenten benötigt, lesen Sie Sollten Sie 2026 von Docusaurus weg migrieren? — Dafür ist Docusaurus besser geeignet.

Wird es wie jede andere Docsbook-Website aussehen?#

Du bestimmst Markenfarben, Schriftarten, Layout, Kopfzeile, Fußzeile, Seitenleiste und deine eigene Domain. Das Einzige, was du nicht entfernen kannst, ist der kleine Link „Powered by Docsbook“ in der Fußzeile – er wird auf jeder Docsbook-Website angezeigt.

Kann ich später umziehen?#

Ja. Deine Dateien befinden sich auf GitHub. Kündige das Abonnement, richte DNS auf einen anderen Anbieter, und deine Inhalte bleiben unverändert.

Füge github.com/yourorg/yourrepo ein, und die Website ist in fünf Sekunden live. Nichts wird aus deinem Repository kopiert, daher bleibt die README die maßgebliche Quelle.

Kostenlos starten — keine Kreditkarte erforderlich

Nächste Schritte#

Updated

War diese Seite hilfreich?

Powered by Docsbook