Anleitungen
Beginnen Sie mit Erste Schritte, wenn Sie zum ersten Mal Dokumentation veröffentlichen. Wechseln Sie zu Erweitert, sobald die Website live ist und Sie sie unter Ihrer eigenen Domain, in mehreren Sprachen oder hinter einer Zugangsbeschränkung benötigen.
Erste Schritte#
- Erstellen Sie Ihre erste Dokumentationsseite — ein Tutorial: Klonen Sie ein Beispiel-Repository, verbinden Sie es und bearbeiten Sie eine Seite.
- Verwalten Sie Ihre Dokumentationsseite — Seiten aktualisieren, eine Veröffentlichung rückgängig machen und eine Website reparieren, die nicht aktualisiert wurde.
Erweitert#
- Benutzerdefinierte Domain einrichten —
docs.yourcompany.comauf deine Dokumentation zeigen lassen, mit einem automatisch ausgestellten SSL-Zertifikat. - Deine Dokumentation übersetzen — 15 Sprachen, jeweils unter einem eigenen indexierten Pfad bereitgestellt.
- Beschränken, wer deine Dokumentation lesen kann — mit einem gemeinsamen Passwort oder deinem eigenen OIDC-Identitätsanbieter.
- Was Docsbook umfasst und was Geld kostet — die Funktionsliste und welche Aktionen das Projektguthaben belasten.
Verwandte Themen#
- Inhalte und Einrichtung — ein Repository verbinden und auswählen, was um Ihre Seiten herum angezeigt wird.
- Übersetzung und i18n — wie übersetzte Seiten gespeichert und bereitgestellt werden.
- Design und Branding — Farben, Logo, Layout und Theme.