Notes de bas de page en Markdown

Introduction aux notes de bas de page

Les notes de bas de page en Markdown permettent d'ajouter des références et des informations supplémentaires de manière ordonnée au sein d’un document. Cela permet d’éviter les longues digressions en gardant le texte principal clair et concis.

Syntaxe des notes de bas de page

Pour insérer une note de bas de page courte, utilisez la syntaxe suivante :

This is a text[^1].
[^1]: This is a reference.

Pour les notes qui nécessitent plus d’une phrase, la syntaxe est comme suit :

[^bignote]: This is a reference that helps correlate information to the document and should be read alongside the relevant paragraph for better understanding.

Exemple concret

Considérons cet exemple où la phrase compare un outil, Pieces, au personnage de Tinkerbell. La note de bas de page fournit des informations sur l’histoire, ce qui le rend accessible à ceux qui ne sont pas familiers avec le conte.

Think of Pieces as a technical Tinkerbell from Peter Pan[^2].
[^2]: This is a fairytale about a forever young boy who takes a group of British children to his home island, Neverland.

Lors du rendu, cela donne :

Think of Pieces as a technical Tinkerbell from Peter Pan[^2].

Conseils pour l'utilisation des notes de bas de page

Voici quelques recommandations pour bien utiliser les notes de bas de page dans votre documentation :

• Veillez à ne pas insérer d’espace entre le mot et le symbole de référence, sinon la note ne s’affichera pas.
• Utilisez les notes de bas de page avec parcimonie afin de ne pas semer la confusion chez les utilisateurs.