Éléments
Typographie MDX et composants utilisés sur les pages de contenu Heff.world
Titres
Référence des niveaux de titres en MDX (# … ######). Une seule balise h1 par page ; privilégier h2 à h4 dans le corps.
Titre 1
Titre 2
Titre 3
Titre 4
Titre 5
Titre 6
Admonition
Composant importé automatiquement dans les fichiers MDX. Exemple d’usage :
<Admonition variant="info">Votre texte ici</Admonition>TIP
Variante variant="tip" pour une astuce ou une bonne pratique.
CAUTION
Variante variant="caution" pour signaler un risque ou un point d’attention.
DANGER
Variante variant="danger" pour déconseiller clairement une action.
INFO
Variante variant="info" pour un complément d’information.
Emphasis
Italique avec astérisques ou tirets bas.
Gras avec astérisques ou tirets bas.
Italique et gras combinés avec astérisques et tirets bas.
Barré avec deux tildes : à rayer.
Link
Lien avec définitions numérotées
Ou laisser vide et utiliser le texte du lien seul.
example.com (sauf sur GitHub, par exemple).
Texte de suite pour montrer que les définitions de liens peuvent suivre.
Paragraph
Sur le web, un paragraphe court fonctionne mieux : une idée par bloc, formulations simples, assez de contexte pour qu’un lecteur en diagonale comprenne l’essentiel.
Ordered List
Élément de liste
Élément de liste
Élément de liste
Élément de liste
Élément de liste
Unordered List
Élément de liste
Élément de liste
Élément de liste
Élément de liste
Élément de liste
Code and Syntax Highlighting
Exemple de code en ligne.
var s = "JavaScript syntax highlighting";
alert(s);s = "Python syntax highlighting"
print sBlockquote
Exemple de citation en bloc.
Tables
| Markdown | Moins | Joli |
|---|---|---|
| Toujours | rendu | propre |
| 1 | 2 | 3 |
Il faut au moins trois tirets entre les cellules d’en-tête. Les barres verticales extérieures (|) sont facultatives ; le Markdown brut n’a pas besoin d’être aligné à la main. Le Markdown en ligne fonctionne dans les cellules.