Tiramisu Docs

Writing

Bases du balisage

Maîtrisez les appels de fonctions, la mise en forme en ligne, les liens, les titres et l'imbrication dans Tiramisu.

Tiramisu utilise une syntaxe d'appels de fonctions pour tout contenu structuré. Le texte brut en dehors des appels de fonctions devient du contenu de paragraphe.

Appels de fonctions

La syntaxe de base est un nom de fonction suivi du contenu entre accolades :

tiramisu
h1 { Hello World }

Les fonctions peuvent avoir des paramètres séparés par des virgules :

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

Paragraphes

Le texte en dehors des appels de fonctions est affiché sous forme de paragraphes. Les lignes vides séparent les paragraphes :

tiramisu
This is the first paragraph.

This is the second paragraph.

Les sauts de ligne simples à l'intérieur d'un paragraphe sont traités comme des espaces.

Mise en forme en ligne

SyntaxeRésultat
bold { text }texte
italic { text }texte
code { text }text

Ces éléments peuvent être imbriqués : gras et italique.

tiramisu
bold { italic { bold and italic } }

Liens

tiramisu
link { url = https://example.com, Link text }

S'affiche ainsi : Texte du lien

Les liens externes (commençant par http:// ou https://) s'ouvrent automatiquement dans un nouvel onglet et affichent une petite icône de lien externe.

Titres

Six niveaux de titres sont disponibles :

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

Les titres génèrent automatiquement des identifiants d'ancrage et apparaissent dans la table des matières.

Imbrication

Les appels de fonctions peuvent être imbriqués les uns dans les autres :

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