innoDoc
>1 Projektstruktur>1.2 Dateien>1.2.1 manifest.yml>

1.2.1 manifest.yml

Jeder Kurs benötigt eine manifest.yml-Datei im Wurzelverzeichnis.
Die Datei beinhaltet Metadaten für den jeweiligen Kurs. Sie wird im YAML-Format verfasst. Im Folgenden finden sich Beschreibungen der möglichen Angaben in dieser Datei.
Info 1.2.1
Eine beispielhafte Manifestdatei befindet sich im Repository dieses Kurses.

title (Pflichtfeld)

Kurstitel
Der Kurstitel wird für jede Sprache angegeben.
title:
    de: TUB Basis-Kurs
    en: TUB Base course

languages (Pflichtfeld)

Kurssprachen
languages: [de, en]
Startseite
Der Wert des Feldes home_link muss ein gültiger interner Link sein, wie im Abschnitt 2.4.1 Interne Links beschrieben. Wird dieses Feld ausgelassen, so wird als Startseite automatisch der erste Abschnitt des Kurses gesetzt.
home_link: /page/welcome

pages (optional)

Definition der Seiten
Wie in Abschnitt 1.1 Ordnerstruktur beschrieben, können zusätzliche Kursseiten angegeben werden.
pages:
  - id: about
    icon: info-circle
    link_in_nav: true
    link_in_footer: true
Jede Seite benötigt zumindest eine id. Aus dieser Angabe ergibt sich der Dateiname der zugehörigen Markdown-Datei, hier also beispielhaft about.md.

icon (optional)

Bezeichner des Menüicons
Der Bezeichner eines Icons zur Darstellung in Menüs. Eine Liste von Bezeichnern ist auf der Webseite von Ant Design zu finden.
Verlinkung in Hauptnavigation und Footer
Gibt an, ob die Seite in der Hauptnavigation bzw. im Footer verlinkt wird.

tikz_preamble (optional)

-Präembel
Siehe Abschnitt 2.7.1 PGF/TikZ-Bilder für eine detaillierte Beschreibung.
tikz_preamble: |
  \usetikzlibrary{arrows,calc}
  \newcommand{\sayhello}{Hello\ World!}

mathjax (optional)

Um spezielle Erweiterungen zu verwenden, kann die MathJax-Konfiguration angepasst werden.
In folgendem Beispiel fügen wir die innodoc-mathjax-Erweiterung hinzu.
mathjax:
  loader:
    load:
      - "[innodoc]/innodoc-mathjax.min.js"
    paths:
      innodoc: http://localhost:8005
  tex:
    packages:
      "[+]":
        - innodoc-mathjax