Das erste Projekt¶
Das Ziel ist klein: eine Seite im Browser und dieselbe Seite als PDF. Sie brauchen Guidedog. Für PDF dienen der eingebettete Compiler oder Typst ab 0.15.1. Siehe Guidedog bauen und installieren.
Installieren Sie unter macOS das Release mit brew install insanai/guidedog/guidedog. Dabei wird der offizielle Tap hinzugefügt; der PDF-Compiler ist enthalten.
Das Projekt erstellen¶
Führen Sie dies in einem Verzeichnis aus, in dem notes noch nicht existiert:
guidedog quickstart notes -q -p "Field Notes" -a "Your name" -v 1.0
Guidedog schreibt Konfiguration, erstes RST-Dokument und editierbare Vorlagen. Es erstellt außerdem Ordner für Bilder, Audio und Video. Ein bestehendes Projekt wird nicht überschrieben.
notes/
conf.toml
index.rst
_templates/
layout.html
book.typ
_static/
guidedog.css
guidedog.js
assets/
images/
audio/
video/
_build/
RST-Dateien enthalten den Inhalt, Vorlagen die Darstellung. quickstart legt _templates/layout.html und _templates/book.typ direkt im Projekt an, nicht in externen Themen oder Paket-Caches. Beide sind jederzeit einsehbar und bearbeitbar.
Die erste Seite schreiben¶
Ersetzen Sie notes/index.rst durch:
Field Notes
===========
A useful explanation begins with a small example.
Measuring a square
------------------
If the side has length :math:`s`, its area is :math:`s^2`.
.. math::
A = s^2
.. note::
State the units before comparing measurements.
Bauen und prüfen¶
guidedog build html notes -W
guidedog build pdf notes -W
Öffnen Sie notes/_build/html/index.html und das PDF in notes/_build/pdf. -W lässt den Build bei Warnungen fehlschlagen; behalten Sie es in Ihren Prüfungen. HTML enthält Navigation und Text, PDF ergänzt die Buchgestaltung. Formeln werden für jedes Ziel gesetzt. Die Einrichtung erklärt Mathematik und Beweise.
Eine Änderung vornehmen¶
guidedog serve notes
Öffnen Sie die ausgegebene Adresse, bearbeiten und speichern Sie die Quelle und laden Sie den Browser neu. Vor der HTML-Auslieferung prüft Guidedog die Änderungszeiten und baut bei neueren Quellen erneut. Es löst keinen Browser-Reload aus. Strg+C beendet den Server.
Bauen Sie erneut, ohne etwas zu ändern. Unveränderte Dokumente werden wiederverwendet. Für den Nachweis aktueller Ausgabe muss nicht jede Seite neu gelesen werden. Weiter geht es mit Ein kleines Buch erstellen.