Parameter stehen oben im Dokument zwischen den gestrichelten Linien. Im Folgenen werden als Beispiele immer nur bestimmte Parameter angegeben, diese können aber beliebig angegeben werden oder auch nicht.
Ihr habt die Möglichkeit folgende Parameter anzugeben:
Das "en" vor dem Parameternamen steht immer für die Englische Übersetzung.
Große Überschrift
Parametername: display, endisplay
Erscheint ganz oben auf der Seite als größte Überschrift.
Slogan
Parametername: slogan, enslogan
Erscheint unter dem Titel als hervorstechender Satzt. Dieser kann kurz das Thema der Seite erläutern.
Seiten Navigation
Parametername: sidenav
default-wert: index
Links neben dem Inhalt könnt ihr eine eine Seiten Navigation hinzufügen. Dafür müsst ihr in dem Ordner “_data/sidenav” eine .yml-Datei erstellen.
Navigations Karten & Hintergrundbild
Parametername: cards, headerimg
Es besteht die optionale Möglichkeit, Navigationskarten in einem Header anzuzeigen. Diese Funktion ist vorzugsweise für die zuerst besuchten Seiten gedacht, um neue Besucher nicht mit zu vielen Informationen zu bombadieren. cards ist eine Liste von Karten. Jede dieser Karten kann folgene Parameter annehmen:
---
headerimg: link/zu/hintergrundbild
cards:
- title: String
entitle: String
content: String
encontent: String
link: Absolute URL
color: <farbe>
---
Hier findet ihr alle möglichen Werte für <farbe>
Übersicht
Parametername: sections
Die Übersicht erscheint direkt unter dem Slogan. sections ist eine Liste von Einträgen. Jeder dieser Einträge kann folgende Parameter annehmen:
---
sections:
- title: String
entitle: String
description: String
endescription: String
link: [relative oder absolute URL]
---
Table of Contents
Parametername: toc
default-wert: false
Bei True werden Überschriften mit einer vorhandenen ID an der rechten Seite angezeigt und bieten einen Überblick über die Inhalte.
Eine ID id
wird zu einer Überschrift wie folgt hinzugefügt durch ## Überschrift {#id}
---
toc: [true | false]
---
Titel
Parametername: title
default-wert: <display>
Der Titel ist der title im HTML Head und wird somit unter anderem als Titel für den Browser Tab angezeigt. Ist dieser nicht gesetzt, wird dafür die display Variable genommen. Ist diese auch nicht gesetzt, dann wird “Fachschaft Mathe/Info” als Titel gesetzt.
---
title: String
---