Titres et texte

Apprenez à formater le texte, à créer des titres et à styliser le contenu

​

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 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 (SEO).

​

Désactivation des liens d’ancrage

Par défaut, les en-têtes incluent des liens d’ancrage cliquables permettant de pointer directement vers des sections spécifiques. Vous pouvez désactiver ces liens à l’aide de la prop noAnchor dans les en-têtes HTML ou React.

HTML header example

<h2 noAnchor>
En-tête sans lien d’ancrage
</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 syntaxes Markdown pour l’accentuation et la mise en forme du texte.

​

Mise en forme de base

Appliquez ces styles de mise en forme à votre texte :

Style	Syntaxe	Exemple	Résultat
Gras	**texte**	**note importante**	note importante
Italique	_texte_	_emphase_	emphase
Barré	~texte~	~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 :

Type	Syntaxe	Exemple	Résultat
Exposant	<sup>text</sup>	example<sup>2</sup>	example2
Indice	<sub>text</sub>	example<sub>n</sub>	examplen

​

Liens

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.

​

Liens internes

Créez des liens vers d’autres pages de votre documentation en utilisant des chemins relatifs à la racine :

[Démarrage rapide](/quickstart)
[Étapes](/components/steps)

Démarrage rapide
Étapes

Évitez les liens relatifs comme [page](../page), car ils se chargent plus lentement et ne peuvent pas être optimisés aussi efficacement que les liens relatifs à la racine.

​

Liens externes

Pour les ressources externes, indiquez l’URL complète :

[Guide de Markdown](https://www.markdownguide.org/)

Guide Markdown

​

Liens cassés

Vous pouvez vérifier les liens cassés dans votre documentation à l’aide de la CLI :

mint liens brisés

​

Blocs de citation

Les blocs de citation mettent en valeur 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 :

> Cette citation se distingue du contenu principal.

Cette citation met en évidence un élément distinct du contenu principal.

​

Citations sur plusieurs lignes

Pour des citations plus longues ou comportant plusieurs paragraphes :

> Voici le premier paragraphe d’une citation sur plusieurs lignes.
>
> Voici le deuxième paragraphe, séparé par une ligne vide avec « > ».

Ceci est le premier paragraphe d’une citation multilignes.

Ceci est le deuxième paragraphe, séparé par une ligne vide précédée de >.

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 équations mathématiques.

​

Mathématiques en ligne

Utilisez un seul signe dollar, $, pour les expressions mathématiques en ligne :

Le théorème de Pythagore énonce que, dans un triangle rectangle, on a $(a^2 + b^2 = c^2)$.

Le théorème de Pythagore énonce que $(a^2 + b^2 = c^2)$ dans un triangle rectangle.

​

Équations en bloc

Utilisez des doubles signes dollar, $$, pour les équations isolées :

$$
E = mc^2
$$

$$E = mc^2$$

La prise en charge de LaTeX nécessite une syntaxe mathématique correcte. Consultez la documentation LaTeX pour des recommandations 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 blanche.

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 imposer des retours à la ligne à l’intérieur des paragraphes :

Cette ligne se termine ici.<br />
Cette ligne commence à la ligne suivante.

Cette ligne se termine ici.
Cette ligne commence à la ligne suivante.

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 en-têtes pour établir une hiérarchie de contenu claire
• Respectez la hiérarchie des en-têtes (ne passez pas de H2 à H4)
• Rédigez des titres d’en-tête descriptifs et riches en mots-clés

​

Mise en forme du texte

• Utilisez le gras pour mettre en avant, pas pour des paragraphes entiers
• Réservez l’italique aux termes, aux titres ou à une emphase subtile
• Évitez la surmise en forme qui détourne de l’essentiel

​

Liens

• Préférez un texte de lien descriptif à « cliquez ici » ou « en savoir plus »
• Utilisez des chemins relatifs à la racine pour les liens internes
• Vérifiez régulièrement les liens afin d’éviter les liens brisés