Tiramisu Docs

Writing

Markup-Grundlagen

Lernen Sie die Funktionsaufruf-Syntax, Inline-Formatierung, Links und Überschriften in Tiramisu kennen.

Tiramisu verwendet eine Funktionsaufruf-Syntax für alle strukturierten Inhalte. Einfacher Text außerhalb von Funktionsaufrufen wird als Absatzinhalt dargestellt.

Funktionsaufrufe

Die grundlegende Syntax ist ein Funktionsname gefolgt von Inhalt in geschweiften Klammern:

tiramisu
h1 { Hello World }

Funktionen können Parameter haben, die durch Kommas getrennt sind:

tiramisu
link { url = https://example.com, Click here }

Absätze

Text außerhalb von Funktionsaufrufen wird als Absatz gerendert. Leerzeilen trennen Absätze:

tiramisu
Dies ist der erste Absatz.

Dies ist der zweite Absatz.

Einzelne Zeilenumbrüche innerhalb eines Absatzes werden als Leerzeichen behandelt.

Inline-Formatierung

SyntaxErgebnis
bold { text }text
italic { text }text
code { text }text

Diese können verschachtelt werden: fett und kursiv.

tiramisu
bold { italic { fett und kursiv } }
tiramisu
link { url = https://example.com, Linktext }

Wird dargestellt als: Linktext

Externe Links (die mit http:// oder https:// beginnen) öffnen automatisch in einem neuen Tab und zeigen ein kleines Symbol für externe Links an.

Überschriften

Sechs Überschriftenebenen sind verfügbar:

tiramisu
h1 { Heading 1 }
h2 { Heading 2 }
h3 { Heading 3 }
h4 { Heading 4 }
h5 { Heading 5 }
h6 { Heading 6 }

Überschriften generieren automatisch Anker-IDs und erscheinen im Inhaltsverzeichnis.

Verschachtelung

Funktionsaufrufe können ineinander verschachtelt werden:

tiramisu
callout { type = info,
  Use bold { bold } to emphasize key points in your
  link { url = /docs, documentation }.
}
Preview