Übersicht

Schnellstart: Eine Dokumentationswebsite mit Docsbook veröffentlichen

Was Sie lernen werden: wie Sie eine Quelle – ein GitHub-Repository, eine Website oder eine Beschreibung Ihres Produkts – in eine veröffentlichte Docsbook-Dokumentationswebsite mit einer öffentlichen URL, einem Suchindex und Analysen umwandeln.

Bevor Sie beginnen#

Sie benötigen Folgendes:

  • Eine aktuelle Version von Chrome, Firefox, Safari oder Edge.
  • Eine Quelle, und nur eine: ein GitHub-Repository mit mindestens einer .md-Datei, eine öffentliche Website-URL oder zwei Sätze, die beschreiben, was Sie verkaufen.
  • Eine Möglichkeit, sich in Schritt 3 anzumelden: ein GitHub-Konto, ein Google-Konto, eine Apple-ID oder eine E-Mail-Adresse, unter der Sie einen Einmalcode empfangen können.

Sie benötigen weder eine Kreditkarte noch eine Build-Pipeline oder ein Konto vor Schritt 3.

1
Schritt 1 — Einen Entwurf erstellen
  1. Öffnen Sie docsbook.io/start.
  2. Fügen Sie Ihre Quelle in das einzige Feld ein: eine Website-URL, einen Link zu einem GitHub-Repository oder einen Satz über Ihr Produkt. Docsbook erkennt, worum es sich handelt — es gibt keinen Typ zur Auswahl.
  3. Warten Sie, während Docsbook die Quelle liest. In jedem Schritt wird angegeben, was gelesen und gefunden wurde.

Erwartetes Ergebnis: Eine Entwurfsseite wird in ihrem eigenen Adminbereich geöffnet, mit der Seitenanzahl, der Quelle, aus der sie stammt, und allen Bereichen für Branding, Layout und SEO. Es wurde noch kein Konto erstellt.

2
Schritt 2 — Den Entwurf öffnen und überprüfen
  1. Klicken Sie im Adminbereich auf Öffnen oder klicken Sie auf die Vorschau selbst.
  2. Durchsuchen Sie die generierten Seiten wie eine echte Dokumentationswebsite — Kopfzeile, Seitenleistenbaum, Gliederung, Breadcrumbs sowie Zurück/Weiter funktionieren alle.
  3. Verwenden Sie Assistent im Bereich, um Formulierungen zu ändern oder Fragen zur Website zu stellen. Im Nachrichtenfeld öffnet der interaktive Modus die Website neben dem Chat, wobei jeder Block anklickbar ist.

Erwartetes Ergebnis: Sie haben den Entwurf gelesen und wissen, ob er Ihr Produkt korrekt beschreibt. Ein Entwurf von einer Website oder einer Idee bleibt nur in Ihrem Browser, bis Sie ihn veröffentlichen.

3
Schritt 3 — Zum Veröffentlichen anmelden
  1. Klicken Sie auf der Startseite des Bereichs auf Diese Website veröffentlichen oder auf die blaue Schaltfläche in der Symbolleiste der Dokumentation selbst. Sie lautet Veröffentlichen, wenn Sie bisher nichts geändert haben, Änderungen speichern, wenn Sie Änderungen vorgenommen haben, und Eigentümerschaft beanspruchen, wenn Sie über einen Anspruchslink hierher gelangt sind — alle drei Optionen bewirken dasselbe.
  2. Wählen Sie eine Anmeldemethode: GitHub, Google, Apple oder E-Mail mit einem Einmalcode.
  3. Schließen Sie den Anmeldevorgang ab.

Erwartetes Ergebnis: Der Entwurf wird zu einem aktiven Docsbook-Projekt mit einer öffentlichen Adresse, einem Suchindex und Analysen. Nichts von dem, was Sie geschrieben haben, wird erneut erstellt.

Wenn Ihre Website aus einem GitHub-Repository stammt und Sie sich mit Google, Apple oder Ihrer E-Mail-Adresse angemeldet haben, fordert Docsbook Sie außerdem auf, den GitHub-Zugriff zu autorisieren — die Repository-Dateien werden über diese Autorisierung gelesen.

4
Schritt 4 — Die veröffentlichte Website öffnen
  1. Öffnen Sie die von Docsbook angezeigte Adresse. Sie folgt dem unten stehenden Muster.
docsbook.io/{owner}/{repo}
  1. Verwenden Sie das Suchfeld in der Kopfzeile oder drücken Sie Cmd+K (unter Windows und Linux Strg+K) und suchen Sie nach einer Formulierung aus einer Ihrer Seiten.

Erwartetes Ergebnis: Die Seite wird unter einer öffentlichen URL geladen, die Suche gibt Ihre Formulierung zurück und die Website ist lesbar, ohne dass eine Anmeldung erforderlich ist.

Was Sie jetzt haben#

Sie haben eine veröffentlichte Dokumentationswebsite: eine öffentliche URL, eine Volltextsuche, einen sitemap.xml, llms.txt für KI-Agenten sowie Analytics, die Seitenaufrufe ab dem ersten Besucher aufzeichnen. Eine aus einem GitHub-Repository erstellte Website prüft das Repository bei ihrem Aufruf erneut, sodass das Pushen zu GitHub die Seiten ohne einen Build-Schritt aktualisiert.

Nächste Schritte#

Veröffentlichen Sie Ihre erste Website

Fügen Sie ein Repository, eine Website-URL oder einen Satz über Ihr Produkt ein und lesen Sie den Entwurf, bevor Sie sich anmelden.

Updated

War diese Seite hilfreich?