Guidedog / Dokumentation 0.2.0

Guidedog-Handbuch

Einmal schreiben. Klar erklären. Im Web und auf Papier veröffentlichen.

Guidedog erzeugt HTML-Websites und PDF-Bücher aus reStructuredText- und Markdown-Quellen. Eine Python-Umgebung oder externe LaTeX-Installation ist nicht nötig. Die Konvertierungsengine heißt Guidedoc. Typst setzt die PDF-Seiten; Guidedog erzeugt die Website direkt.

Ein kleines Projekt braucht ein Quelldokument, ein Inhaltsverzeichnis und conf.toml. Beginnen Sie mit Das erste Projekt. Für konkrete Aufgaben dient Praktische Aufgaben, für genaue Verträge Referenz.

Abb. 1 Ein Quellprojekt, zwei Veröffentlichungen.

Lernen

• Tutorials

  • Das erste Projekt

  • Ein kleines Buch erstellen

• Themenleitfäden

  • Dokumente verfassen

  • Domänen

  • Wie ein Projekt funktioniert

  • Mathematik und Beweise

  • Diagramme zur Erklärung

  • Typografie zum Lesen

  • Vorlagen

  • Bilder, Video, Audio und Downloads

  • Internationalisierung

  • Auf andere Projekte verweisen

  • Objekttypen deklarieren

  • Python mit autodoc dokumentieren

  • Odin dokumentieren

Arbeiten

• Praktische Aufgaben

  • Guidedog bauen und installieren

  • Dokumentation bauen und veröffentlichen

  • Ein Sphinx-Projekt migrieren

  • Eine Codebasis dokumentieren

  • Diese Dokumentation pflegen

• Referenz

  • Kommandozeilenreferenz

  • Konfigurationsreferenz

  • Reader, Renderer und Builder

  • Fehlermeldungen

  • Kompatibilität mit Sphinx

Verstehen

• Interna

  • Die Guidedoc-Engine

  • Invarianten vor Algorithmen

  • Eine vollständige Generation veröffentlichen

  • Speicher und Eigentümerschaft

• Über dieses Handbuch

  • Nachweise der Builds

• Guidedog

  • Ein Projekt beginnen

  • Installieren

  • Aus dem Quellcode bauen

  • Mit Guidedog übersetzen

  • Lesen und einbetten

  • Danksagung und Lizenz

API-Referenz

• API Reference