Erstelle deine erste Dokumentationswebsite

In diesem Tutorial veröffentlichst du eine Dokumentationswebsite aus einem GitHub-Repository und änderst eine Seite darauf. Du benötigst keine Programmiererfahrung und musst nichts installieren: Jeder Schritt findet in einem Browser statt.

Das hast du am Ende: eine live geschaltete Dokumentationswebsite unter docsbook.io/YOUR-USERNAME/docs und eine Seite darauf, die du selbst bearbeitet hast.

Bevor Sie beginnen#

Sie benötigen zwei Dinge:

• Einen Browser und eine Internetverbindung. Jedes Betriebssystem funktioniert.
• Ein GitHub-Konto. Es ist kostenlos. In Schritt 1 wird eines erstellt, falls Sie noch keines haben.

Was ist GitHub? GitHub ist eine Website, auf der Menschen Textdateien speichern und teilen. Stellen Sie sich Google Drive vor, entwickelt für Dokumentation und Code. Docsbook liest Ihre Dateien aus GitHub und veröffentlicht sie als Dokumentationswebsite.

Schritt 1: Ein GitHub-Konto erstellen#

Überspringen Sie diesen Schritt, wenn Sie bereits ein Konto haben.

1. Rufen Sie github.com auf.
2. Klicken Sie oben rechts auf Sign up.
3. Geben Sie Ihre E-Mail-Adresse ein und wählen Sie ein Passwort.
4. Wählen Sie einen Benutzernamen. Er erscheint in Ihrer Dokumentations-URL, wie in docsbook.io/your-username/your-repo.
5. Bestätigen Sie den Bestätigungscode, den GitHub Ihnen per E-Mail sendet.

Schritt 2: Das Beispiel-Repository forken#

Ein Repository – kurz „Repo“ – ist ein Ordner auf GitHub, der deine Dokumentationsdateien enthält. Ein Repository veröffentlicht eine Dokumentationswebsite.

Statt mit einem leeren Repository zu beginnen, kopierst du das Docsbook-Beispiel-Repository. Das Kopieren des Repositorys einer anderen Person wird als Forken bezeichnet, und deine Kopie ist unabhängig: Was du änderst, wirkt sich nie auf das Original aus.

1. Gehe zu github.com/docsbook-io/docs.

   

2. Klicke oben rechts auf Fork.

3. Übernimm alle Einstellungen und klicke auf Create fork.

   

4. GitHub öffnet dein neues Repository unter github.com/YOUR-USERNAME/docs.

   

Du hast jetzt ein Repository mit Beispieldokumentation, das zur Veröffentlichung bereit ist.

Schritt 3: Repository mit Docsbook verbinden#

1. Rufe docsbook.io/connect auf.

   

2. Wähle eine Anmeldemethode — GitHub, Google, Apple oder einen einmaligen Code per E-Mail — und schließe die Anmeldung ab.

3. Wenn du dich mit Google, Apple oder per E-Mail angemeldet hast, bittet Docsbook um Zugriff auf GitHub. Klicke auf docsbook autorisieren.

   Docsbook liest die Dateien in deinem Repository. Es kann nichts in deinem Repository ändern oder löschen, es sei denn, du bittest es darum.

4. Suche das von dir geforkte Repository in der Liste und klicke darauf.

   

5. Docsbook erstellt deine Website und leitet dich dorthin weiter.

Deine Dokumentation ist jetzt verfügbar unter:

docsbook.io/YOUR-GITHUB-USERNAME/docs

Öffne sie und klicke dich durch die Seitenleiste. Jede Seite, die du siehst, ist eine Markdown-Datei in dem von dir geforkten Repository.

Schritt 4: Eine Seite auf GitHub bearbeiten#

1. Öffnen Sie Ihr Repository unter github.com/YOUR-USERNAME/docs.

2. Klicken Sie auf die Datei, die Sie ändern möchten — beginnen Sie mit README.md.

   

3. Klicken Sie oben rechts neben der Datei auf das Bleistiftsymbol.

   

4. Ändern Sie einen Satz. Die Datei ist in Markdown geschrieben: **bold** wird fett dargestellt, # Heading wird als große Überschrift dargestellt. Die Referenz zur Markdown-Syntax am Ende dieser Seite behandelt den Rest.

   

5. Scrollen Sie nach unten zu Änderungen committen.

6. Schreiben Sie eine kurze Notiz, die beschreibt, was Sie geändert haben, zum Beispiel „Einleitung aktualisieren“.

7. Klicken Sie auf Änderungen committen.

   

Schritt 5: Die Änderung auf Ihrer Website anzeigen#

Gehen Sie zurück zu Ihrer Docsbook-Website und laden Sie die bearbeitete Seite neu. Ihr neuer Satz ist dort.

Das ist der gesamte Ablauf: Führen Sie einen Commit auf GitHub durch, und die veröffentlichte Website folgt. Sie haben das Tutorial abgeschlossen.

Seiten hinzufügen und löschen#

Das Hinzufügen einer Seite erfolgt nach demselben Ablauf mit einer anderen Schaltfläche.

Eine Seite hinzufügen:

1. Öffne dein Repository und klicke auf Add file → Create new file.

   

2. Gib unter Name your file den Pfad und Dateinamen ein, zum Beispiel guides/installation.md. Durch die Eingabe eines / wird der Ordner erstellt.

   

3. Schreibe den Inhalt und klicke auf Commit new file.

Die Seite erscheint automatisch in der Seitenleiste deines Docsbooks.

Eine Seite löschen:

1. Öffne die Datei in deinem Repository.

2. Klicke auf das Menü ⋯ oben rechts.

   

3. Klicke auf Delete file und anschließend auf Commit changes.

Andere Möglichkeiten, dies zu tun#

Das obige Tutorial verwendet den Weg, der ohne installierte Software funktioniert. Sobald Sie über die erste Website hinaus sind, gibt es drei Alternativen.

Beginnen Sie mit einem leeren Repository, anstatt eines zu forken. Gehen Sie zu github.com/new, geben Sie dem Repository einen kurzen Namen ohne Leerzeichen, wählen Sie Public, aktivieren Sie Add a README file und klicken Sie auf Create repository. Verbinden Sie es anschließend genau wie in Schritt 3.

Schreiben Sie Seiten mit einem KI-Coding-Assistenten. Claude Code liest, erstellt und bearbeitet Dateien im Dialog. Das ist schneller, wenn Sie viele Seiten auf einmal erstellen. Installieren Sie es über claude.ai/code, bitten Sie es, Ihr Repository zu klonen, und beschreiben Sie dann, was Sie möchten — „create guides/installation.md with sections for requirements, installation and first login“. Wenn Sie fertig sind, weisen Sie es an, einen Commit zu erstellen und die Änderungen zu übertragen, und Ihre Website wird aktualisiert.

Bearbeiten Sie die veröffentlichte Seite direkt. Sobald Ihre Website verbunden ist, können Sie einen Block auf der Seite, die Sie gerade lesen, im Docsbook-AI-Chat ändern – ohne GitHub und ohne Installation. Siehe Bearbeiten auf der Live-Seite.

Referenz: Markdown-Syntax#

Markdown ist eine Reihe von Symbolen, die die Formatierung steuern. Dies sind die Symbole, die in der Dokumentation verwendet werden.

Text#

Überschriften, Listen und Links#

# Large heading (page title)
## Medium heading (section)
### Small heading (sub-section)
 
- First item
- Second item
  - Nested item, indented by two spaces
 
1. First step
2. Second step
 
[Link to an external site](https://example.com)
[Link to another page in your docs](/docsbook-io/docs/guides/getting-started/managing-docs)

Bilder und Codeblöcke#

![Fork dialog with the Create fork button highlighted](https://raw.githubusercontent.com/docsbook-io/docs/main/guides/getting-started/images/fork-dialog.png)

Schließe einen Codeblock mit drei Backticks ein und benenne die Sprache, damit die Syntaxhervorhebung aktiviert wird:

```javascript
console.log("Hello!")
```

Hinweise#

> This is a note or an important callout.

Referenz: Wie Ihre Dateien zu Seiten werden#

Docsbook erstellt die Seitenleiste aus Ihren Datei- und Ordnernamen. Es gibt nichts zu konfigurieren.

Daraus ergeben sich drei Regeln:

• Datei- und Ordnernamen werden zu Seitentiteln, wobei Bindestriche durch Leerzeichen ersetzt werden.
• README.md in einem Ordner wird zur Indexseite dieses Ordners.
• Kleingeschriebene Namen mit Bindestrichen erzeugen lesbare URLs: getting-started.md wird zu /getting-started.

Welche Reihenfolge diese Seiten haben, erfahren Sie unter Ihre Dokumentationswebsite verwalten.

Nächste Schritte#

• Ihre Dokumentationswebsite verwalten — Inhalte aktualisieren, Zugriff steuern und eine Website reparieren, die nicht aktualisiert wurde.
• Eine benutzerdefinierte Domain einrichten — die Dokumentation unter docs.yourcompany.com bereitstellen.
• Volltextsuche aktivieren — Lesern ermöglichen, eine Seite anhand eines Schlüsselworts zu finden.