Les en-têtes organisent votre contenu et créent des ancres de navigation. Ils apparaissent dans la table des matières et aident les utilisateurs à parcourir votre documentation.
Utilisez les symboles # pour créer des en-têtes de différents niveaux :
Copy
## 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 indiquent clairement le contenu à venir. Cela améliore à la fois la navigation des utilisateurs et le référencement.
Par défaut, les en-têtes incluent des liens d’ancrage cliquables permettant aux utilisateurs de renvoyer 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.
Copy
<h2 noAnchor>Header without anchor link</h2>
Lorsque noAnchor est utilisé, l’en-tête n’affiche pas la puce d’ancrage et un clic 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.
É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.
Pour des citations plus longues ou comportant plusieurs paragraphes :
Copy
> 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 multilignes.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 pertinence. Envisagez d’utiliser des encadrés pour les notes, les avertissements et autres informations.
Utilisez deux signes dollar, $$, pour des équations indépendantes :
Copy
$$E = mc^2$$
E=mc2
La prise en charge de LaTeX nécessite une syntaxe mathématique correcte. Consultez la documentation LaTeX pour des recommandations complètes en matière de syntaxe.
