Link „Auf GitHub bearbeiten“ hinzufügen

Der Link Auf GitHub bearbeiten wird unten auf jeder Seite Ihrer Docsbook-Website angezeigt und öffnet die Quelldatei dieser Seite im GitHub-Editor. Leser, die einen Tippfehler entdecken, können ihn korrigieren und einen Pull Request eröffnen, ohne etwas über Docsbook wissen zu müssen.

Suchen Sie etwas anderes? Diese Seite behandelt den Bearbeitungslink für Leser. Um ein GitHub-Konto zu verbinden oder ein auf Docsbook gehostetes Projekt in ein Repository zu verschieben, das Sie besitzen, öffnen Sie die Projektauswahl in der Kopfzeile des KI-Chats und verwenden Sie Verbundenes Repository — siehe Schnellstart.

Was die beiden Einstellungen bewirken#

Einstellung	Was sie bewirkt
„Auf GitHub bearbeiten“ anzeigen	Fügt den Bearbeitungslink am Ende jeder Seite hinzu
Basis-URL für die GitHub-Bearbeitung	Der Basispfad, aus dem der Link erstellt wird

Bearbeitungslink aktivieren#

Öffnen Sie Ihre Dokumentationsseite, während Sie angemeldet sind.
Öffnen Sie die Registerkarte Float Widget → Design → Inhalt.
Aktivieren Sie „Auf GitHub bearbeiten“ anzeigen.
Legen Sie die GitHub-Basis-URL zum Bearbeiten fest – siehe nächster Abschnitt.
Klicken Sie auf Speichern.

GitHub-Basis-URL zum Bearbeiten festlegen#

Die Basis-URL zum Bearbeiten gibt an, wohin Docsbook Leser weiterleiten soll, die auf den Link klicken. Docsbook hängt den Pfad der aktuellen Seite daran an.

https://github.com/YOUR_USERNAME/YOUR_REPO/edit/YOUR_BRANCH/YOUR_DOCS_FOLDER

Wählen Sie die Zeile aus, die dem Speicherort Ihrer Markdown-Dateien entspricht:

Repository	Speicherort der Dokumentation	Basis-URL zum Bearbeiten
`myname/my-repo`	Stammverzeichnis des Repositorys	`https://github.com/myname/my-repo/edit/main`
`myname/my-repo`	Ordner `/docs`	`https://github.com/myname/my-repo/edit/main/docs`
`myname/my-repo`	Branch `master`	`https://github.com/myname/my-repo/edit/master`

Lassen Sie das Feld leer, erstellt Docsbook den Link aus dem von Ihnen verbundenen Repository.

Wann sollte es aktiviert werden#

Für ein Open-Source-Projekt ist der Bearbeitungslink der einfachste Weg zur Mitwirkung, den Sie anbieten können: Eine lesende Person korrigiert eine falsche Option oder eine veraltete Versionsnummer direkt im Browser, und Sie erhalten einen Pull Request statt eines Issues.

Für interne Teamdokumentation kann jedes Teammitglied eine Änderung der Formulierung vorschlagen, ohne die Docsbook-Oberfläche erlernen zu müssen – die Datei wird auf GitHub bearbeitet, und die Website übernimmt die Änderung.

Der Bearbeitungslink ruft kein KI-Modell auf und belastet daher nicht das Guthaben Ihres Projekts.

Nächste Schritte#

Inhaltsoptionen — die anderen Umschalter auf derselben Design-Registerkarte.
Ihre Dokumentationswebsite verwalten — wie eine Bearbeitung auf GitHub Ihre Live-Website erreicht.

Verwandeln Sie Ihre Leser in Mitwirkende

Jedes neue Projekt startet mit 1 $ Guthaben, und der Bearbeitungslink verbraucht dieses Guthaben nicht.

Projekt erstellen