La structure des fichiers Markdown
Le Markdown n'est pas un langage de programmation, mais un langage de balisage léger qui permet de structurer des documents de texte, pour un usage web, sans écrire le moindre élément HTML. Il favorise la lisibilité et la sémantique, chaque balise Markdown sert à organiser l'information plutôt que de définir son style.
Le « Front Matter »
Le Markdown prend en charge les métadonnées comme le ferait une page HTML, dans un encadré nommé « Front Matter » qui peut se traduire par Page de garde. Ces métadonnées sont rangées en haut de la page Markdown, dans un format nommé YAML (équivalent à du JSON avec une syntaxe simplifiée).
Les ancres des liens internes
Nous avons vu, dans un précédent guide, qu'il était possible de créer des liens en Markdown. Nous allons maintenant voir plus en détail comment fonctionnent les liens internes, leurs ancres et le types de liens qui existent.
Les exemples interactifs
Pour permettre aux lecteur·ice·s d'expérimenter ce que la documentation présente, nous créons des exemples qui sont rendus interactifs grâce aux macros, mais surtout aux blocs de codes.
Les blocs de codes
Le MDN est une documentation des technologies utilisées sur le web, par les développeur·euse·s de site et applications. Pour présenter les différents aspects d'une technologie, nous utilisons des blocs de code qui prennent diverses formes selon le besoin.
Les macros et leur fonctionnement
Pour rendre des éléments dans la documentation, tels que des liens vers des ressources, des bannières prédéfinies, des exemples, des badges et des barres de navigation ; nous utilisons un élément de code personnalisé nomme « macro ». Elles sont formées par l'ouverture et la fermeture d'accolades doubles {{ avec le nom de la macro et ses paramètres avant la fermeture }}.