Mettre en forme le texte

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 ## (H2) à ###### (H6) pour les sections de contenu. H1 est réservé au titre de la page défini dans votre frontmatter, n’ajoutez donc pas de titre de niveau supérieur # dans le corps de la page.

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.

IDs de titre personnalisés

Par défaut, Mintlify génère automatiquement les IDs d’ancrage à partir du texte du titre. Vous pouvez remplacer l’ID généré par un ID personnalisé en utilisant la syntaxe {#custom-id} :

## My section {#my-custom-anchor}
### Configuration options {#config}
##### Deep detail {#detail}

L’ID personnalisé remplace l’ancrage généré automatiquement. Vous pouvez ainsi créer un lien vers le titre avec #my-custom-anchor ou #config au lieu du texte slugifié par défaut. Cela est utile lorsque vous souhaitez des liens d’ancrage stables qui ne changent pas si vous modifiez le texte du titre, ou lorsque vous avez besoin d’ancrages plus courts et plus faciles à retenir.

Désactivation des liens d’ancrage

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>

<Heading level={2} noAnchor>
Header without anchor link
</Heading>

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 :

Style	Syntaxe	Exemple	Ré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 :

Type	Syntaxe	Exemple	Résultat
Exposant	`<sup>text</sup>`	`example<sup>2</sup>`	example²
Indice	`<sub>text</sub>`	`example<sub>n</sub>`	example_n

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 à l’aide de chemins relatifs à la racine. Omettez l’extension de fichier (.mdx ou .md). Les chemins relatifs et les chemins comportant une extension ne fonctionnent pas en production.

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

Démarrage rapide
Étapes

Liens externes

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

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

Guide Markdown

Liens brisés

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.

Ce texte se démarque du contenu principal.

Bloc citations sur plusieurs lignes

Pour des citations plus longues ou plusieurs paragraphes :

> 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 `>`.

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 styling.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

(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 = 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.

Filets horizontaux

Utilisez la syntaxe Markdown --- ou les balises HTML <hr /> pour ajouter un filet horizontal qui sépare visuellement les sections de contenu :

Content preceding the rule.

<hr />

Content following the rule.

Contenu précédant le filet.

Contenu suivant le filet.

Utilisez les filets horizontaux avec parcimonie. Dans la plupart des cas, les titres offrent une meilleure séparation du contenu avec l’avantage supplémentaire des ancres de navigation.

Commentaires

Utilisez des commentaires de style MDX pour ajouter des notes, des rappels ou des tâches à faire dans vos fichiers sources. Les commentaires ne s’affichent pas sur la page publiée.

{/* Ceci est un commentaire et n'apparaîtra pas dans la documentation publiée. */}

{/*
  Les commentaires multi-lignes fonctionnent aussi.
  Utiles pour les tâches à faire ou les notes aux relecteurs.
*/}

Les commentaires de style HTML  ne sont pas pris en charge en MDX. Utilisez toujours {/* ... */}.

Échapper les caractères spéciaux

MDX interprète { et } comme le début et la fin d’une expression JSX, et < comme le début d’une balise JSX. Lorsque vous souhaitez que ces caractères s’affichent comme du texte littéral, échappez-les pour que MDX n’essaie pas de les analyser.

Caractère	Comment l’échapper
`{` et `}`	Encadrez le caractère par des accents graves (`{`), utilisez l’entité HTML (`{` pour `{`, `}` pour `}`) ou écrivez-le dans une expression JSX sous forme de chaîne (`{'{'}`).
`<`	Encadrez par des accents graves (`<`), utilisez l’entité HTML `<`, ou écrivez `{'<'}`.
`	Utilisez une barre oblique inverse (\`) ou encadrez une plus longue portion par des doubles accents graves ( code avec ` à l’intérieur ).
`\`	Utilisez une double barre oblique inverse (`\\`).

Exemples d'échappement

Utilisez la syntaxe `{variable}` pour interpoler des valeurs.

L'emplacement &#123;name&#125; s'affiche comme des accolades littérales.

En JSX, écrivez {'{ key: value }'} pour afficher un objet littéral.

Dans les blocs de code délimités (```), MDX n’analyse pas les accolades, vous pouvez donc écrire {variable} directement sans échappement. L’échappement n’est requis que dans le texte courant et à l’intérieur des attributs JSX.

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 au lieu de « 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 rompus

​En-têtes

​Création de titres

​IDs de titre personnalisés

​Désactivation des liens d’ancrage

​Mise en forme du texte

​Mise en forme de base

​Combiner les formats

​Exposant et indice

​Liens

​Liens internes

​Liens externes

​Liens brisés

​Citations

​Bloc de citation sur une seule ligne

​Bloc citations sur plusieurs lignes

​Expressions mathématiques

​Mathématiques en ligne

​Équations en bloc

​Sauts de ligne et espaces

​Sauts de paragraphe

​Sauts de ligne manuels

​Filets horizontaux

​Commentaires

​Échapper les caractères spéciaux

​Bonnes pratiques

​Organisation du contenu

​Mise en forme du texte

​Liens

En-têtes

Création de titres

IDs de titre personnalisés

Désactivation des liens d’ancrage

Mise en forme du texte

Mise en forme de base

Combiner les formats

Exposant et indice

Liens

Liens internes

Liens externes

Liens brisés

Citations

Bloc de citation sur une seule ligne

Bloc citations sur plusieurs lignes

Expressions mathématiques

Mathématiques en ligne

Équations en bloc

Sauts de ligne et espaces

Sauts de paragraphe

Sauts de ligne manuels

Filets horizontaux

Commentaires

Échapper les caractères spéciaux

Bonnes pratiques

Organisation du contenu

Mise en forme du texte

Liens