Projektseite erzeugen

Diese Seite ist ein Teil der IsyFact-Standards. Alle Inhalte der Seite, insbesondere Texte und Grafiken, sind urheberrechtlich geschützt. Alle urheberrechtlichen Nutzungs- und Verwertungsrechte liegen beim Bundesverwaltungsamt.

Creative Commons Namensnennung Die Nutzung ist unter den Lizenzbedingungen der Creative Commons Namensnennung 4.0 International gestattet.

Die Generierung einer Projektseite erfolgt, falls das Repository isyfact.github.io verwendet wird, wie in vergleichbaren npm-Projekten. Nachdem alle Abhängigkeiten installiert wurden, wird die Projektseite mit dem Befehl npm build erzeugt.

1. Aufbau des Playbooks

Die offizielle Antora-Dokumentation beschreibt das Playbook. Deshalb wird hier nur auf die IsyFact-Besonderheiten eingegangen.

Listing 1. Playbook der Online-Dokumentation

site:
  title: IsyFact
  url: https://isyfact.github.io/
  start_page: isyfact-standards-doku:einstieg:einstieg.adoc
content:
  sources:
    # ... (1)
runtime:
  fetch: true
asciidoc:
  attributes:
    page-toctitle: Inhalt
    sectnums: true             (2)
    sectnumlevels: 5           (3)
    caution-caption: Achtung   (4)
    important-caption: Wichtig
    note-caption: Hinweis
    tip-caption: Tipp
    warning-caption: Warnung
    appendix-caption: Anhang
    example-caption: Beispiel
    figure-caption: Abbildung
    table-caption: Tabelle
    listing-caption: Listing
ui:
  bundle:
    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable (5)
    snapshot: true
  supplemental_files: ./supplemental-ui (6)
output:
  dir: ./docs

1	Die Einbindung von Antora-Komponenten beschreibt der Guide "Veröffentlichung von Inhalten".
2	Abschnitte sollen nummeriert werden.
3	Die Abschnitte dürfen bis Level 5 geschachtelt sein (möglich, aber nicht empfohlen).
4	Vordefinierte Captions auf Deutsch.
5	Standard-UI von Antora.
6	Ergänzungen der IsyFact zum Standard-UI.

2. Supplemental UI

Unter dem im Playbook unter supplemental_files angegebenen Pfad kann das Standard-UI von Antora leicht mit CSS und JavaScript überschrieben werden. Dies sollte jedoch nur bei kleineren Änderungen genutzt werden, bei größeren Änderungen empfiehlt es sich, ein eigenes UI zu schreiben, ggf. auf Basis des Standard-UIs.