Webseiten-Generierung (GitLab Pages)

Die CIAbkürzung für „Continuous Integration“ – eine Entwicklungspraxis, bei der Codeänderungen automatisch gebaut, getestet und häufig in ein zentrales Repository integriert werden, um Integrationsprobleme frühzeitig zu erkennen und eine hohe Codequalität sicherzustellen.-Komponente md-to-gitlab-page erstellt eine statische Webseite aus Markdown-Dateien und veröffentlicht sie als GitLabGitLab ist eine umfassende, webbasierte DevOps-Plattform (Entwicklungs- und Betriebplattform) für die Verwaltung von Git-Repositories, kontinuierliche Integration (CI) und kollaborative Softwareentwicklung. Page über openCodeopenCode ist die Plattform für digitale Souveränität. Sie bringt Open Source in den öffentlichen Sektor Deutschlands. Gemeinsam entwickeln und teilen wir Software, die unsere digitale Zukunft selbstbestimmt gestaltet..

# 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 RepositoryEin zentraler, versionskontrollierter Speicherort für Quellcode und zugehörige Dateien, der die gemeinsame Entwicklung und Änderungsverfolgung erleichtert., ausgehend vom Stammverzeichnis), das in eine PDFPortable Document Format/UAUniversal Accessibility-konforme PDFPortable Document Format-Datei umgewandelt werden soll.
  Standardwert: document

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

Web-Ansicht

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

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

• opencode-repo-url: URLUniform Resource Locator – Die Adresse, die zur Angabe des Speicherorts einer Ressource im Internet verwendet wird. des RepositorysEin zentraler, versionskontrollierter Speicherort für Quellcode und zugehörige Dateien, der die gemeinsame Entwicklung und Änderungsverfolgung erleichtert., in dem die GitLabGitLab ist eine umfassende, webbasierte DevOps-Plattform (Entwicklungs- und Betriebplattform) für die Verwaltung von Git-Repositories, kontinuierliche Integration (CI) und kollaborative Softwareentwicklung. Page gepflegt wird. Wenn eine URLUniform Resource Locator – Die Adresse, die zur Angabe des Speicherorts einer Ressource im Internet verwendet wird. gesetzt ist, wird ein openCodeopenCode ist die Plattform für digitale Souveränität. Sie bringt Open Source in den öffentlichen Sektor Deutschlands. Gemeinsam entwickeln und teilen wir Software, die unsere digitale Zukunft selbstbestimmt gestaltet.-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 (SVGAbkürzung für „Scalable Vector Graphics“ – ein XML-basiertes Vektorbildformat für zweidimensionale Grafiken mit Unterstützung für Interaktivität und Animation., PNG, JPG), das im Header angezeigt wird.
  Standardwert: ""

• footer-logo-path: Pfad zum Logo-Bild (SVGAbkürzung für „Scalable Vector Graphics“ – ein XML-basiertes Vektorbildformat für zweidimensionale Grafiken mit Unterstützung für Interaktivität und Animation., PNG, JPG), das im Footer angezeigt wird.
  Standardwert: ""

• feedback-server-url: URLUniform Resource Locator – Die Adresse, die zur Angabe des Speicherorts einer Ressource im Internet verwendet wird. des Feedback-Servers. Wenn gesetzt, wird die Feedback-Funktion aktiviert.
  Standardwert: ""

• repository-url: URLUniform Resource Locator – Die Adresse, die zur Angabe des Speicherorts einer Ressource im Internet verwendet wird. des RepositorysEin zentraler, versionskontrollierter Speicherort für Quellcode und zugehörige Dateien, der die gemeinsame Entwicklung und Änderungsverfolgung erleichtert.. Wenn gesetzt, wird ein Link zum RepositoryEin zentraler, versionskontrollierter Speicherort für Quellcode und zugehörige Dateien, der die gemeinsame Entwicklung und Änderungsverfolgung erleichtert. neben der Suchleiste angezeigt.
  Standardwert: ""

Deployment

• deploy-only-on: Definiert, wann die GitLabGitLab ist eine umfassende, webbasierte DevOps-Plattform (Entwicklungs- und Betriebplattform) für die Verwaltung von Git-Repositories, kontinuierliche Integration (CI) und kollaborative Softwareentwicklung. Page veröffentlicht wird. Wählen Sie tagsum ausschließlich auf Git-Tags eine neue Version zu deployen. Alternativ können Sie einen BranchEin Branch in der Softwareentwicklung ist ein unabhängiges Arbeitsgebiet, das aus der Hauptlinie der Entwicklung abgezweigt wird. Entwickler können an einem Branch unabhängig arbeiten, ohne die Hauptlinie zu beeinträchtigen.-Namen angeben (z. B. main). Dann führt jeder commitEin Commit beschreibt in der Softwareentwicklung das Speichern von Änderungen in einem Versionskontrollsystem wie Git. Dabei wird der Zustand des Projekts dokumentiert, sodass Änderungen nachvollzogen, rückgängig gemacht oder gemeinsam entwickelt werden können. zu einem aktualisierten Deployment.
  Standardwert: tags

Sonstiges

• umami-url: URLUniform Resource Locator – Die Adresse, die zur Angabe des Speicherorts einer Ressource im Internet verwendet wird. des Umami-Servers, der für die Web-Analyse verwendet wird. (github.com/umami-software/umami)
  Standardwert: ""

• umami-website-id: IDAbkürzung für „Identifier“ – ein eindeutiger Wert oder Token, der verwendet wird, um eine Entität von anderen zu unterscheiden. der Website, die in Umami registriert ist.
  Standardwert: ""