mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
b9bb94f159
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
278 lines
7.8 KiB
Plaintext
278 lines
7.8 KiB
Plaintext
---
|
||
title: "Mettre en forme le texte"
|
||
description: "Apprenez à mettre en forme le texte, à créer des titres et à styliser le contenu."
|
||
keywords: ["Mise en forme Markdown", "style du texte", "titres", "liens d’ancrage"]
|
||
---
|
||
|
||
<div id="headers">
|
||
## En-têtes
|
||
</div>
|
||
|
||
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.
|
||
|
||
<div id="creating-headers">
|
||
### Création de titres
|
||
</div>
|
||
|
||
Utilisez le symbole `#` pour créer des titres de différents niveaux :
|
||
|
||
```mdx
|
||
## En-tête de section principale
|
||
### En-tête de sous-section
|
||
#### En-tête de sous-sous-section
|
||
```
|
||
|
||
<Tip>
|
||
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.
|
||
</Tip>
|
||
|
||
<div id="disabling-anchor-links">
|
||
### Désactivation des liens d’ancrage
|
||
</div>
|
||
|
||
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.
|
||
|
||
<CodeGroup>
|
||
```mdx HTML header example
|
||
<h2 noAnchor>
|
||
Header without anchor link
|
||
</h2>
|
||
```
|
||
|
||
```mdx React header example
|
||
<Heading level={2} noAnchor>
|
||
Header without anchor link
|
||
</Heading>
|
||
```
|
||
</CodeGroup>
|
||
|
||
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.
|
||
|
||
<div id="text-formatting">
|
||
## Mise en forme du texte
|
||
</div>
|
||
|
||
Nous prenons en charge la plupart des formats Markdown pour mettre en valeur et styliser le texte.
|
||
|
||
<div id="basic-formatting">
|
||
### Mise en forme de base
|
||
</div>
|
||
|
||
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~~ |
|
||
|
||
<div id="combining-formats">
|
||
### Combiner les formats
|
||
</div>
|
||
|
||
Vous pouvez combiner différents styles de mise en forme :
|
||
|
||
```mdx
|
||
**_gras et italique_**
|
||
**~~gras et barré~~**
|
||
*~~italique et barré~~*
|
||
```
|
||
|
||
***gras et italique***<br />
|
||
**~~gras et barré~~**<br />
|
||
*~~italique et barré~~*
|
||
|
||
<div id="superscript-and-subscript">
|
||
### Exposant et indice
|
||
</div>
|
||
|
||
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<sup>2</sup> |
|
||
| Indice | `<sub>text</sub>` | `example<sub>n</sub>` | example<sub>n</sub> |
|
||
|
||
<div id="links">
|
||
## Liens
|
||
</div>
|
||
|
||
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.
|
||
|
||
<div id="internal-links">
|
||
### Liens internes
|
||
</div>
|
||
|
||
Créez des liens vers d’autres pages de votre documentation à l’aide de chemins relatifs à la racine :
|
||
|
||
```mdx
|
||
[Démarrage rapide](/quickstart)
|
||
[Étapes](/components/steps)
|
||
```
|
||
|
||
[Démarrage rapide](/fr/quickstart)<br />
|
||
[Étapes](/fr/components/steps)
|
||
|
||
<div id="external-links">
|
||
### Liens externes
|
||
</div>
|
||
|
||
Pour les ressources externes, incluez l’URL complète :
|
||
|
||
```mdx
|
||
[Guide Markdown](https://www.markdownguide.org/)
|
||
```
|
||
|
||
[Guide Markdown](https://www.markdownguide.org/)
|
||
|
||
<div id="broken-links">
|
||
### Liens brisés
|
||
</div>
|
||
|
||
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](/fr/installation)
|
||
|
||
```bash
|
||
mint broken-links
|
||
```
|
||
|
||
<div id="blockquotes">
|
||
## Citations
|
||
</div>
|
||
|
||
Les citations mettent en avant des informations importantes, des citations ou des exemples dans votre contenu.
|
||
|
||
<div id="single-line-blockquotes">
|
||
### Bloc de citation sur une seule ligne
|
||
</div>
|
||
|
||
Ajoutez `>` avant le texte pour créer un bloc de citation :
|
||
|
||
```mdx
|
||
> Ceci est une citation qui se distingue du contenu principal.
|
||
```
|
||
|
||
> Cette citation se démarque du contenu principal.
|
||
|
||
<div id="multi-line-blockquotes">
|
||
### Bloc citations sur plusieurs lignes
|
||
</div>
|
||
|
||
Pour des citations plus longues ou plusieurs paragraphes :
|
||
|
||
```mdx
|
||
> 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 `>`.
|
||
|
||
<Tip>
|
||
Utilisez les blocs de citation avec parcimonie pour préserver leur impact visuel et leur portée. Envisagez d’utiliser des [encarts](/fr/components/callouts) pour les notes, avertissements et autres informations.
|
||
</Tip>
|
||
|
||
<div id="mathematical-expressions">
|
||
## Expressions mathématiques
|
||
</div>
|
||
|
||
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](/fr/organize/settings#param-latex).
|
||
|
||
<div id="inline-math">
|
||
### Mathématiques en ligne
|
||
</div>
|
||
|
||
Utilisez un seul signe dollar, « $ », pour les expressions mathématiques en ligne :
|
||
|
||
```mdx
|
||
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.
|
||
|
||
<div id="block-equations">
|
||
### Équations en bloc
|
||
</div>
|
||
|
||
Utilisez deux signes dollar, `$$`, pour les équations isolées :
|
||
|
||
```mdx
|
||
$$
|
||
E = mc^2
|
||
$$
|
||
```
|
||
|
||
$$
|
||
E = mc^2
|
||
$$
|
||
|
||
<Info>
|
||
La prise en charge de LaTeX requiert une syntaxe mathématique correcte. Consultez la [documentation LaTeX](https://www.latex-project.org/help/documentation/) pour des consignes complètes sur la syntaxe.
|
||
</Info>
|
||
|
||
<div id="line-breaks-and-spacing">
|
||
## Sauts de ligne et espaces
|
||
</div>
|
||
|
||
Maîtrisez les espaces et les retours à la ligne pour améliorer la lisibilité du contenu.
|
||
|
||
<div id="paragraph-breaks">
|
||
### Sauts de paragraphe
|
||
</div>
|
||
|
||
Séparez les paragraphes par des lignes vides :
|
||
|
||
```mdx
|
||
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.
|
||
|
||
<div id="manual-line-breaks">
|
||
### Sauts de ligne manuels
|
||
</div>
|
||
|
||
Utilisez les balises HTML `<br />` pour forcer des retours à la ligne au sein des paragraphes :
|
||
|
||
```mdx
|
||
Cette ligne se termine ici.<br />
|
||
Cette ligne commence sur une nouvelle ligne.
|
||
```
|
||
|
||
Cette ligne se termine ici.<br />
|
||
Cette ligne commence sur une nouvelle ligne.
|
||
|
||
<Tip>
|
||
Dans la plupart des cas, des sauts de paragraphe avec ligne blanche offrent une meilleure lisibilité que des retours à la ligne manuels.
|
||
</Tip>
|
||
|
||
<div id="best-practices">
|
||
## Bonnes pratiques
|
||
</div>
|
||
|
||
<div id="content-organization">
|
||
### Organisation du contenu
|
||
</div>
|
||
|
||
* 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
|
||
|
||
<div id="text-formatting">
|
||
### Mise en forme du texte
|
||
</div>
|
||
|
||
* 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 |