​
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 rapidement votre documentation.

​
Création d’en-têtes

Utilisez le symbole # pour créer des en-têtes de différents niveaux : 
## Titre de section principal
### Titre de sous-section
#### Titre de sous-sous-section
Utilisez des en-têtes 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 qui permettent aux utilisateurs de pointer directement 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’ancre 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 mises en forme 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****note importante**note importante
Italique_text__mise en évidence_mise en évidence
Barré~text~~fonction obsolète~fonction obsolète

​
Combiner les formats

Vous pouvez combiner des 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 en utilisant des chemins relatifs à la racine : 
[Quickstart](/quickstart)
[Steps](/components/steps)
Quickstart
Steps
Évitez les liens relatifs comme [page](../page) : ils se chargent plus lentement et ne peuvent pas être optimisés aussi efficacement que les liens relatifs à la racine.
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 cassés dans votre documentation à l’aide de la CLI : 
mint broken-links

​
Citations en bloc

Les citations en bloc mettent en avant des informations importantes, des citations ou des exemples au sein de votre contenu.

​
Citations sur une seule ligne

Ajoutez > avant le texte pour créer un bloc de citation : 
> This is a quote that stands out from the main content.
Cette citation se détache du contenu principal.

​
Citations multilignes

Pour des citations plus longues ou sur plusieurs paragraphes : 
> This is the first paragraph of a multi-line blockquote.
>
> This is the second paragraph, separated by an empty line with `>`.
Voici le premier paragraphe d’une citation multilignes. Voici le deuxième paragraphe, séparé par une ligne vide avec >.
Utilisez les citations avec parcimonie pour préserver leur impact visuel et leur portée. Envisagez d’utiliser des encadrés pour les notes, avertissements et autres informations.

​
Expressions mathématiques

Nous prenons en charge LaTeX pour le rendu des expressions et des équations mathématiques.

​
Mathématiques en ligne

Utilisez des signes dollar simples, $, pour les expressions mathématiques en ligne : 
The Pythagorean theorem states that $(a^2 + b^2 = c^2)$ in a right triangle.
Le théorème de Pythagore énonce que (a2+b2=c2)(a^2 + b^2 = c^2) dans un triangle rectangle.

​
Équations en bloc

Utilisez les doubles signes dollar, $$, pour les équations autonomes : 
$$
E = mc^2
$$
E=mc2E = mc^2
La prise en charge de LaTeX nécessite une syntaxe mathématique correcte. Consultez la documentation LaTeX pour des consignes détaillées sur la syntaxe.

​
Retours à la ligne et espacement

Gérez l’espacement et les sauts de 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 vide.

​
Sauts de ligne manuels

Utilisez des balises HTML <br /> pour forcer des retours à la ligne au sein des paragraphes : 
This line ends here.<br />
This line starts on a new line.
Cette ligne se termine ici.
Cette ligne commence sur une nouvelle ligne.
Dans la plupart des cas, des sauts de paragraphe séparés par des lignes vides offrent une meilleure lisibilité que des retours à la ligne manuels.

​
Bonnes pratiques

​
Organisation du contenu

  • Utilisez des titres pour créer une hiérarchie de contenu claire
  • Respectez une hiérarchie de titres cohérente (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 valeur, pas pour des paragraphes entiers
  • Réservez l’italique aux termes, titres ou nuances d’emphase
  • Évitez la surmise en forme qui détourne l’attention du contenu
  • 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 pour éviter les liens brisés