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.
Utilisez le symbole # pour créer des titres de différents niveaux :
Signaler un code incorrect
Copier
Demander à l'IA
## 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 IDs d’ancrage sont générés automatiquement à partir du texte du titre. Vous pouvez remplacer l’ID généré par un ID personnalisé en utilisant la syntaxe {#custom-id} :
Signaler un code incorrect
Copier
Demander à l'IA
## 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.
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.
Signaler un code incorrect
Copier
Demander à l'IA
<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.
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.
Pour des citations plus longues ou plusieurs paragraphes :
Signaler un code incorrect
Copier
Demander à l'IA
> 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.
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.
