Dokumente generieren

Die zweite Verwendung von configlet ist das Generieren von Dokumenten.

Verwendung

Mit dem Befehl generate kannst du Anleitungs- und Einführungsdokumente aus einer Vorlage generieren.

configlet [global-options] generate

Global options:
  -h, --help                   Show this help message and exit
      --version                Show this tool's version information and exit
  -t, --track-dir <dir>        Specify a track directory to use instead of the current directory
  -v, --verbosity <verbosity>  The verbosity of output. Allowed values: q[uiet], n[ormal], d[etailed]

Dokumente

Dies sind die Dokumente, die configlet generieren kann.

Dokument: introduction.md-Datei einer Konzept-Übung

Jede Konzept-Übung hat eine introduction.md-Datei. Jede Übung kann optional eine introduction.md.tpl-Datei haben.

Die Vorlagendatei wird wie eine normale Markdown-Datei behandelt, mit einer Ergänzung: Du kannst Platzhalter angeben. Die folgenden Platzhalter werden unterstützt:

• %{concept:<slug>}: verweist auf das introduction.md-Dokument des Konzepts

Wenn configlet erkennt, dass eine Konzept-Übung eine introduction.md.tpl-Datei hat, generiert es daraus eine introduction.md-Datei. Die generierte Einführung hat denselben Inhalt wie die Vorlage, außer den Platzhaltern, die durch den Inhalt der Dokumente ersetzt werden, auf die sie verweisen.

Dokument: introduction.md-Datei einer Praxis-Übung

Wenn configlet erkennt, dass eine Praxis-Übung eine Problem-Specifications-Übung implementiert, die eine introduction.md-Datei hat, synchronisiert configlet die .meta/introduction.md-Datei der Praxis-Übung mit der introduction.md-Datei der Problem-Specifications-Übung.

Dokument: instructions.md-Datei einer Praxis-Übung

Wenn configlet erkennt, dass eine Praxis-Übung eine Problem-Specifications-Übung implementiert, synchronisiert configlet die .meta/instructions.md-Datei der Praxis-Übung entweder mit der instructions.md-Datei der Problem-Specifications-Übung oder, wenn keine instructions.md-Datei gefunden wurde, mit deren description.md-Datei.

Dokument: .meta/config.json-Datei einer Praxis-Übung

Wenn configlet erkennt, dass eine Praxis-Übung eine Problem-Specifications-Übung implementiert, synchronisiert configlet die Schlüssel source und source_url aus der metadata.yml-Datei der Problem-Specifications-Übung mit den Eigenschaften source und source_url in der .meta/config.json-Datei der Praxis-Übung.