Doctave

Doctave ist eine Dokumentationsplattform, die die Flexibilität des Schreibens in Markdown mit der Leistungsfähigkeit professionellen Dokumentationshostings kombiniert. Sie schreiben Ihre Dokumentation in einfachen Textdateien, speichern sie zusammen mit Ihrem Code in Git, und Doctave sorgt dafür, dass daraus schöne, durchsuchbare Dokumentationswebsites werden.

Die Plattform unterstützt sowohl reguläre Markdown-Anleitungen als auch OpenAPI-Spezifikationen für API-Dokumentationen. Sie erstellt automatisch Vorschauumgebungen, wenn Sie Änderungen vornehmen, sodass Ihr Team Updates vor der Veröffentlichung überprüfen kann. Alles bleibt in Ihrem Git-Repository, wodurch Sie die volle Versionskontrolle über Ihre Dokumentation behalten.

Doctave Studio ist die begleitende Desktop-Anwendung, die Echtzeitvorschauen, Autovervollständigungsvorschläge, Überprüfung auf defekte Links und Rechtschreibprüfung bietet. Zusammen helfen diese Tools Teams dabei, Dokumentationen zu erstellen, die aktuell und genau bleiben.

Der Einstieg mit Doctave ist unkompliziert. So verwenden Sie es effektiv:

• Erstellen Sie einen Dokumentationsordner in Ihrem Code-Repository und verfassen Sie Ihre Inhalte mit Markdown-Dateien. Fügen Sie eine README.md-Datei als Startseite hinzu.

• Installieren Sie Doctave Studio auf Ihrem Computer, um Ihre Dokumentation lokal mit Echtzeit-Updates während des Schreibens vorzuschauen.

• Richten Sie Ihre doctave.yml-Konfigurationsdatei ein, um die Struktur Ihrer Dokumentation, Farbschemata und Navigationslinks festzulegen.

• Verbinden Sie Ihr Git-Repository über die Plattform mit Doctave. Bei jedem Push aktualisiert Doctave automatisch Ihre veröffentlichte Dokumentation.

• Für API-Dokumentationen fügen Sie Ihre OpenAPI-Spezifikationsdatei zu Ihrem Repository hinzu. Doctave generiert automatisch interaktive API-Referenzseiten.

• Verwenden Sie Git-Branches, um verschiedene Versionen Ihrer Dokumentation zu verwalten. Erstellen Sie Pull Requests, um Änderungen vor der Veröffentlichung zu überprüfen, und Doctave generiert Vorschau-Links für jeden Pull Request.

• Git-basierter Dokumentationsworkflow mit Versionskontrolle

• Doctave Studio Desktop-Editor mit Echtzeitvorschau

• Unterstützung der OpenAPI-Spezifikation für API-Dokumentation

• Automatische Vorschauumgebungen für Pull Requests

• Verwaltung von Dokumentationen in mehreren Versionen

• Eingebaute Suche über alle Inhalte

• Optionen für individuelles Branding und Design

• Leseranalyse und Feedbacksammlung

• CI/CD-Integration für automatische Bereitstellung

• Passwortgeschützte Dokumentationsoptionen