Den Compiler fragen, nicht eine alte Vorlage.
Diese Befehle bilden die tägliche Oberfläche. Verwenden Sie denjenigen, der die tatsächliche Frage beantwortet.
| Ich möchte… | Befehl | Ergebnis |
|---|---|---|
| Dokumenttypen sehen | docc types | Bekannte Typen mit Beschreibung und Theme. |
| Anforderungen eines Typs verstehen | docc describe ch_letter | Den ganzen Vertrag: Frontmatter, Struktur, Semantik, Leerfelder und Regeln. |
| Eine gültige Quelldatei starten | docc example ch_letter > brief.md | Ein kompaktes, vom Schema gepflegtes Beispiel. |
| Alle Probleme vor Ausgabe sehen | docc check brief.md | Gesammelte Diagnosen mit Position und Hinweis. |
| Das Word-Dokument erstellen | docc build brief.md | Prüfung vor Ausgabe, dann .docx neben der Quelle. |
| Geparsten Inhalt als Daten lesen | docc read brief.md | Frontmatter, Text, Spans und Felder als JSON. |
| Die wirksame Konfiguration sehen | docc doctor | Aufgelöste Schemas, Themes und Profilquelle. |
| Editor-Diagnosen erhalten | docc lsp | Language Server über Standard-Ein- und Ausgabe. |
--json verwenden. Erfolgreiche Resultate bleiben auf stdout strukturiert; Build-Diagnosen sind separates JSON auf stderr.Eine Quelle, eine Rückmeldeschleife.
Entdecken. Mit types, describe und example wird der Vertrag sichtbar, bevor das Schreiben beginnt.
Verfassen. Markdown und Frontmatter bearbeiten; Tatsachen als Daten, Aussagen als Prosa behalten.
Prüfen. docc check während des Schreibens ausführen oder dieselben Diagnosen im Editor anzeigen lassen.
Erstellen. Nur bestandene Quellen rendern. Das Profil liefert das feste Erscheinungsbild; der Compiler den Nachweis für erfüllte Anforderungen.
Inputs prüfen. Änderungen an Quelle, Schema, Theme oder Lockdatei sind echte Dokumentänderungen. Builds bleiben deterministisch.
# Ein expliziter CI-Check. docc check --strict docs/*.md # Maschinenlesbare Variante. docc check --json docs/*.md
Nach der konkreten Frage vertiefen.
Wenn ein Dokument nicht baut, bei der Quellzeile anfangen.
Fehlercode, Caret und Hinweis lesen. Zuerst die verfasste Datei korrigieren. Bei einer Typanforderung docc describe <type> nutzen; bei Unsicherheit über Profil oder Theme docc doctor oder docc profile status.
docc check brief.md # Tatsachen oder Struktur aus der Diagnose korrigieren. docc describe ch_letter # Dokumentvertrag erneut ansehen. docc doctor # Auswahl von Schema und Theme prüfen.