Créer des alertes et des notes

Des balises spécifiques sous forme d’extension du language Markdown permettent de créer des alertes visuelles très simplement. Voici des exemples :

Note:

Ceci est une note simple

La syntaxe de base est simple @[tip](Ceci est une note simple). Le texte peut être directement injecté en argument.

Il est également possible de modifier le titre de l’alerte en rajoutant un argument. Le fonctionnement de cette synthaxe n’autorise malheureusement qu’un argument. Il est donc nécessaire de fournir un tableau de chaînes de caractères en json valide ["titre", "texte"]. Par exemple : @[tip](["Plus complexe", "La syntaxe ..."]) donne le résultat suivant.

Plus complexe:

La syntaxe de cette note est plus complexe car le titre a été changé. Attention au format!

L’objectif de ces alertes est de guider, alerter, voir congratuler l’utilisateur lors de sa lecture.



Types d'alerte

Il existe plusieurs types d’alertes, chacune avec son icône et sa couleur propre. Le choix du type d’alerte se fait à travers la première balise @[<type d'alerte>](). Les types actuellement disponibles sont

  • success
Info:

Ca avance

  • tip
Note:

L’attention est attirée mais ce n’est pas un élément majeur

  • alert
Attention:

Ne surtout pas rater cette information!


Styliser le contenu

Le texte contenu dans la note peut être stylisé en suivant la syntaxe standard de Markdown (single line code, gras, etc.)

Critique à savoir:

Il est possible de mettre des éléments Markdown à l’intérieur du texte pour peu qu’il tienne sur une ligne


Limitations

Bien qu’il soit possible d’accéder au Markdown à l’intérieur du texte du contenu, la limitation majeure de ces nouvelles balises est le multi-ligne. Il n’est pas possible de tapper plusieurs lignes en markdown à l’intérieur de la parenthèse.

Il est possible néanmoins d’utiliser des astuces comme l’injection manuelle de balises html dans le code Markdow afin d’influer sur le résultat final du texte. Par exemple, ici des retours à la ligne sont insérés en html <br /> :

Limitations:

Lorsque plusieurs lignes sont désirées

il faut mettre de l’html dans le texte.