Qgoda ist ein [Kommandozeilenprogramm](http://www.guido-flohr.net/de/kommandozeile/.
Die allgemeine Verwendung von Qgoda sieht so aus:
$ qgoda [GLOBAL_OPTIONS] [COMMAND, [OPTIONS]]
Zum Beispiel:
$ qgoda --verbose build --drafts --future
So wird die globale Option —verbose
auf wahr gesetzt, und das Qgoda-Kommando build
mit den Optionen —darfst
und —future
ausgewählt.
Qgoda unterstützt zur Zeit die folgenden globalen Optionen.
Das nächste Token auf der Kommandozeile muss eins der unterstützten Kommandos sein, zur Zeit „build“, „watch“, „config“, „init“, „dump“, „markdown“, „xgettext“ oder „po“.
Der Rest der Kommandozeile besteht aus Optionen für das jeweilige Kommando. Mit qgoda KOMMANDO --help
werden hilfreiche Hinweise für ein bestimmtes Kommando angezeigt (wobei KOMMANDO
natürlich mit einem der unterstützten Kommandos ersetzt werden muss). Die Option -h
bzw. --help
wird von allen Qgoda-Kommandos unterstützt.
Die Benutzungshinweise werden mithilfe des System-Pacers angezeigt. Mit der Taste q
wird dieser verlassen. LEERZEICHEN
blättert eine Seite, Pfeil-nach-unten oder j
eine Zeile vor. Mit k
wird eine Zeile zurückgeblättert, und h
zeigt weitere Hilfe.
Das Kommando build
weist Qgoda an, die Site (neu) zu generieren und sich dann zu beenden. Hilfsprogramme werden nicht ausgeführt!
Tut das gleiche wie build
, aber statt sich zu beenden, wartet Qgoda auf Änderungen an Dateien, und initiiert eine Neu-Generierung, sobald sich eine Quelldatei ändert.
Hilfsprogramme werden parallel gestartet.
Dumps the current configuration as YAML and exits. The configuration printed is the result of merging the default configuration with the files _qgoda.yaml
and _localqgoda.yaml
.
Initialisiert eine neue Qgoda-Site.
Dumpt den kompletten Content der Seite. Die Ausgabe ist geeignet, um den Inhalt an externe Programm (zum Beispiel Volltext-Suchmaschinen wie elasticsearch zu übergeben.
Generiert html aus einer Markdown-Datei. Damit können Probleme mit der Markdown-Verarbeitung untersucht werden.
Diverse Kommandos für mehrsprachige Web-Sites. Siehe für Details.
Extrahiert übersetzbare Schnipsels aus den Markdown-Quelldateien der Site in .po
-Dateien. Dieses Kommand wird intern von qgoda po pot
(siehe oben) aufgerufen, weshalb `qgoda xget
Extracts translatable snippets from the site's markdown source files into .po
. files. This command is invoked implicitely by qgoda po pot
(see above), and you normally don't have to use qgoda xgettext
directly. See for more information.