Webseiten-Generierung (GitLab Pages)

Die CI-Komponente md-to-gitlab-page erstellt eine statische Webseite aus Markdown-Dateien und veröffentlicht sie als GitLab Page über openCode.

# gitlab-ci.yml
include:
- component: $CI_SERVER_FQDN/open-code/document-writing-tools/document-writing-ci-components/md-to-web@v2
  inputs:
    md-path: dokument
    document-title: "Beispiel Markdown zu Kern Web"
    deploy-only-on: "main"
    footer-copyright: "© 2025 Zentrum für Digitale Souveränität der Öffentlichen Verwaltung (ZenDiS) GmbH"
    umbrella-brand: "true" # Aktiviert die Kopf- und Fußzeile der Dachmarke
    encrypt-page: "true" # Mit konfiguriertem Passwort (ENCRYPT_PASSWORD CI Variable) wird die Seite verschlüsselt.
    theme: "kernux"
    logo-path: "dokument//assets/logo.svg"
    repository-url: "https://gitlab.opencode.de/archrl-it-bund/architekturrichtlinie-fur-die-it-des-bundes"

⚙️ Parameter

Wird in der Stage build ausgeführt.

Quell-Dateien

• md-path: Pfad zum Markdown-Dokument (Ordner im Repository, ausgehend vom Stammverzeichnis), das in eine PDF/UA-konforme PDF-Datei umgewandelt werden soll.
  Standardwert: document

• template-path: Pfad zum Ordner, der die Template-Dateien (z. B. auch Schriftarten) für die PDF-Datei enthält.
  Standardwert: template

Web-Ansicht

• document-title: Titel des Dokuments, der in der PDF-Datei angezeigt wird.
  Standardwert: Document

• footer-copyright: Text, der im Footer der PDF-Datei angezeigt wird. Der Prefix © <aktuelles-Jahr> wird automatisch gesetzt.
  Standardwert: "© <aktuelles-Jahr> Bundesministerium des Innern und für Heimat"

• opencode-repo-url: URL des Repositorys, in dem die GitLab Page gepflegt wird. Wenn eine URL gesetzt ist, wird ein openCode-Icon mit dem angegebenen Link in der Navigationsleiste ergänzt.
  Standardwert: ""

Erweiterte Optionen für die Webbook CI-Komponente

• umbrella-brand: Wenn auf true gesetzt, wird die Dachmarken-Header-Komponente angezeigt.
  Standardwert: false

• encrypt-page: Wenn auf true gesetzt, wird die Seite nach dem Build mit einem Passwort verschlüsselt. Das Passwort muss über die Umgebungsvariable ENCRYPT_PASSWORD bereitgestellt werden.
  Standardwert: false

• enable-self-assessment: Aktiviert die Self-Assessment-Funktion für die Seite.
  Standardwert: false

• theme: Legt das Theme für das Webbook fest. Mögliche Werte sind kernux oder bund.
  Standardwert: kernux

• logo-path: Pfad zum Logo-Bild (SVG, PNG, JPG), das im Header angezeigt wird.
  Standardwert: ""

• footer-logo-path: Pfad zum Logo-Bild (SVG, PNG, JPG), das im Footer angezeigt wird.
  Standardwert: ""

• feedback-server-url: URL des Feedback-Servers. Wenn gesetzt, wird die Feedback-Funktion aktiviert.
  Standardwert: ""

• repository-url: URL des Repositorys. Wenn gesetzt, wird ein Link zum Repository neben der Suchleiste angezeigt.
  Standardwert: ""

Deployment

• deploy-only-on: Definiert, wann die GitLab Page veröffentlicht wird. Wählen Sie tagsum ausschließlich auf Git-Tags eine neue Version zu deployen. Alternativ können Sie einen Branch-Namen angeben (z. B. main). Dann führt jeder commit zu einem aktualisierten Deployment.
  Standardwert: tags

Sonstiges

• umami-url: URL des Umami-Servers, der für die Web-Analyse verwendet wird. (github.com/umami-software/umami)
  Standardwert: ""

• umami-website-id: ID der Website, die in Umami registriert ist.
  Standardwert: ""