Markdown Webbook CLI

Die markdown-webbook CLI ist ein leistungsstarkes Werkzeug, das es dir ermöglicht, Markdown-Dateien in statische HTML-Seiten zu konvertieren.

Installation

echo "@document-writing-tools:registry=https://gitlab.opencode.de/api/v4/projects/2542/packages/npm/" >> ~/.npmrc
npm install -g @document-writing-tools/markdown-webbook

Grundlegende Verwendung

markdown-webbook --input <input-directory> --output <output-directory>

Erforderliche Optionen

--input <dir> or -i <dir> Der Pfad zum Verzeichnis, das die Markdown-Dateien enthält.

markdown-webbook --input ./docs --output ./dist

Optionale Optionen

--output <dir> oder -o <dir> Ausgabeverzeichnis für statische HTML-Dateien. Erforderlich für den Build-Modus, optional für den Watch-Modus (Standardwert ist ./dist).
--watch oder -w Entwicklungsserver mit Dateiüberwachung starten. Wenn diese Option aktiviert ist, führt die CLI folgende Schritte aus:
- Einrichten einer temporären Entwicklungsumgebung
- Starten eines Next.js-Entwicklungsservers
- Überwachen von Dateiänderungen im Input-Ordner und automatisches Aktualisieren der Vorschau
- Das Standardausgabeverzeichnis ist ./dist, sofern nicht anders angegeben.
--selfassessment Aktiviere das Self-Assessment. Diese Funktion verarbeitet spezielle Kommentarblöcke in Markdown-Dateien, die Bewertungsfragen enthalten.
--theme <name> Das anzuwendende Thema. Mögliche Werte: bund | kernux. Standardwert ist kernux.
--title <string> Titel des Webbooks. Wird in der Navigationsleiste angezeigt. Kann leer sein.
--dachmarke Enable Dachmarke in the header and footer. See Digital Dachmarke documentation.
--logo-path <path> Pfad zur Logo-Bilddatei (svg, png, jpg), die in der Kopfzeile angezeigt werden soll.
--footer-logo-path <path> Pfad zur Bilddatei des Fußzeilenlogos (svg, png, jpg).
--copyright <string> Copyright-Hinweis zur Anzeige in der Fußzeile.
--repository-url <url> URL zum Quellcode-Repository. Wenn diese Option aktiviert ist, wird in der Navigationsleiste ein kleines openCode-Symbol angezeigt, das zum Repository führt.

Feedback Funktion

--feedback-gitlab-project-id <id> GitLab-Projekt-ID für die Feedback-Funktion.
--feedback-server-url <url> Feedback-Server-URL. Siehe Feedback-Server-Dokumentation.
--feedback-issue-link <url> Link zur GitLab-Issue-Seite für Feedback.

Beispiele

Grundlegender Build

Markdown-Dateien in statisches HTML umwandeln:

markdown-webbook --input ./content --output ./out

Development Mode

Entwicklungsserver mit Dateiüberwachung starten:

markdown-webbook --input ./content --watch

Full Configuration

Mit allen Funktionen erstellen:

markdown-webbook \
  --input ./docs \
  --output ./dist \
  --selfassessment \
  --theme kernux \
  --title "Government Documentation" \
  --dachmarke \
  --logo-path /assets/logo.svg \
  --footer-logo-path /assets/footer-logo.png \
  --copyright "© 2025 Government Agency" \
  --repository-url "https://gitlab.opencode.de/myproject" \
  --feedback-gitlab-project-id "12345" \
  --feedback-server-url "https://feedback.gov.de" \
  --feedback-issue-link "https://gitlab.opencode.de/myproject/-/issues"

Eingabeverzeichnisstruktur

TODO

Self-Assessment Format

Wenn Sie --selfassessment verwenden, fügen Sie Bewertungsfragen in Ihren Markdown-Dateien in diesem Format ein:

# Your Content
 
Regular markdown content here.
 
<!---Self Assessment: This section is reserved for questions for the self assessment. The content of this block will not be displayed in the PDF.
 
###### Main question title? [Tag] ######
 1. Sub-question 1? [SubTag]
     1. Detailed question 1? []
     2. Detailed question 2? [DetailTag]
 2. Sub-question 2? [AnotherTag]
     1. Another detailed question? []
 
--->

Umgebungsvariablen

Die CLI berücksichtigt die folgenden Umgebungsvariablen:

STATIC_EXPORT=true - Wird während des Build-Prozesses automatisch gesetzt.

Versionsinformationen

Überprüfen Sie die CLI-Version:

markdown-webbook --version

Hilfe erhalten:

markdown-webbook --help

Menü