Passer au contenu principal

​
En-têtes

Les en-têtes structurent votre contenu et créent des ancres de navigation. Ils apparaissent dans la table des matières et aident les utilisateurs à parcourir votre documentation d’un coup d’œil.

​
Création de titres

Utilisez le symbole # pour créer des titres de différents niveaux : 
## En-tête de section principale
### En-tête de sous-section
#### En-tête de sous-sous-section
Utilisez des titres descriptifs, riches en mots-clés, qui annoncent clairement le contenu à venir. Cela améliore la navigation des utilisateurs et le référencement.
Par défaut, les en-têtes incluent des liens d’ancrage cliquables permettant aux utilisateurs de créer un lien direct vers des sections spécifiques. Vous pouvez désactiver ces liens d’ancrage à l’aide de la prop noAnchor dans les en-têtes HTML ou React. 
<h2 noAnchor>
Header without anchor link
</h2>
Lorsque noAnchor est utilisé, l’en-tête n’affiche pas la puce d’ancrage et cliquer sur le texte de l’en-tête ne copie pas le lien d’ancrage dans le presse‑papiers.

​
Mise en forme du texte

Nous prenons en charge la plupart des formats Markdown pour mettre en valeur et styliser le texte.

​
Mise en forme de base

Appliquez ces styles de mise en forme à votre texte :
StyleSyntaxeExempleRésultat
Gras**text****important note**note importante
Italique_text__emphasis_emphase
Barré~text~~deprecated feature~fonctionnalité obsolète

​
Combiner les formats

Vous pouvez combiner différents styles de mise en forme : 
**_gras et italique_**
**~~gras et barré~~**
*~~italique et barré~~*
gras et italique
gras et barré
italique et barré

​
Exposant et indice

Pour les expressions mathématiques ou les notes de bas de page, utilisez des balises HTML :
TypeSyntaxeExempleRésultat
Exposant<sup>text</sup>example<sup>2</sup>example2
Indice<sub>text</sub>example<sub>n</sub>examplen
Les liens aident les utilisateurs à naviguer entre les pages et à accéder à des ressources externes. Utilisez un libellé de lien descriptif pour améliorer l’accessibilité et l’expérience utilisateur. Créez des liens vers d’autres pages de votre documentation à l’aide de chemins relatifs à la racine : 
[Démarrage rapide](/quickstart)
[Étapes](/components/steps)
Démarrage rapide
Étapes Pour les ressources externes, incluez l’URL complète : 
[Guide Markdown](https://www.markdownguide.org/)
Guide Markdown Vous pouvez vérifier la présence de liens brisés dans votre documentation à l’aide de l’interface en ligne de commande (CLI) : CLI 
mint broken-links

​
Citations

Les citations mettent en avant des informations importantes, des citations ou des exemples dans votre contenu.

​
Bloc de citation sur une seule ligne

Ajoutez > avant le texte pour créer un bloc de citation : 
> Ceci est une citation qui se distingue du contenu principal.
Cette citation se démarque du contenu principal.

​
Bloc citations sur plusieurs lignes

Pour des citations plus longues ou plusieurs paragraphes : 
> Ceci est le premier paragraphe d'une citation multiligne.
>
> Ceci est le second paragraphe, séparé par une ligne vide avec `>`.
Voici le premier paragraphe d’un bloc de citation sur plusieurs lignes. Voici le deuxième paragraphe, séparé par une ligne vide précédée de >.
Utilisez les blocs de citation avec parcimonie pour préserver leur impact visuel et leur portée. Envisagez d’utiliser des encarts pour les notes, avertissements et autres informations.

​
Expressions mathématiques

Nous prenons en charge LaTeX pour le rendu des expressions et équations mathématiques. Vous pouvez remplacer la détection automatique en configurant styles.latex dans le fichier docs.json de vos paramètres.

​
Mathématiques en ligne

Utilisez un seul signe dollar, « $ », pour les expressions mathématiques en ligne : 
Le théorème de Pythagore énonce que $(a^2 + b^2 = c^2)$ dans un triangle rectangle.
Le théorème de Pythagore stipule que (a2+b2=c2)(a^2 + b^2 = c^2) dans un triangle rectangle.

​
Équations en bloc

Utilisez deux signes dollar, $$, pour les équations isolées : 
$$
E = mc^2
$$
E=mc2E = mc^2
La prise en charge de LaTeX requiert une syntaxe mathématique correcte. Consultez la documentation LaTeX pour des consignes complètes sur la syntaxe.

​
Sauts de ligne et espaces

Maîtrisez les espaces et les retours à la ligne pour améliorer la lisibilité du contenu.

​
Sauts de paragraphe

Séparez les paragraphes par des lignes vides : 
Ceci est le premier paragraphe.

Ceci est le deuxième paragraphe, séparé par une ligne vide.
Ceci est le premier paragraphe. Ceci est le deuxième paragraphe, séparé par une ligne blanche.

​
Sauts de ligne manuels

Utilisez les balises HTML <br /> pour forcer des retours à la ligne au sein des paragraphes : 
Cette ligne se termine ici.<br />
Cette ligne commence sur une nouvelle ligne.
Cette ligne se termine ici.
Cette ligne commence sur une nouvelle ligne.
Dans la plupart des cas, des sauts de paragraphe avec ligne blanche offrent une meilleure lisibilité que des retours à la ligne manuels.

​
Bonnes pratiques

​
Organisation du contenu

  • Utilisez des titres pour établir une hiérarchie claire
  • Respectez la hiérarchie des titres (ne passez pas de H2 à H4)
  • Rédigez des titres descriptifs et riches en mots-clés

​
Mise en forme du texte

  • Utilisez le gras pour mettre en évidence, pas pour des paragraphes entiers
  • Réservez l’italique aux termes, titres ou nuances d’emphase
  • Évitez la mise en forme excessive qui détourne l’attention du contenu

​
Liens

  • Rédigez un texte de lien descriptif plutôt que « cliquez ici » ou « en savoir plus »
  • Utilisez des chemins relatifs à la racine pour les liens internes
  • Testez régulièrement les liens afin d’éviter les liens rompus