Markdown en entrée

TOC généré

Exemples de TOC Markdown

Générer des liens d'ancre à partir des titres. Exemple :

Titres du manuel du projet

Markdown en entrée :

Entrée

TOC généré :

Sortie

Utilisez Exemple ci-dessus pour charger plus de titres.

Qu'est-ce qu'un générateur TOC Markdown ?

Une table des matières (TOC) aide les lecteurs à naviguer dans les documents longs. En Markdown, les titres utilisent # jusqu'à ######. Un générateur TOC scanne vos titres et produit une liste de liens vers chaque section. GitHub Flavored Markdown et de nombreux générateurs de sites statiques prennent en charge les liens d'ancre générés à partir du texte du titre.

Cet outil s'exécute dans votre navigateur. Collez du Markdown ou téléchargez un fichier ; le TOC se met à jour à l'édition. Vous pouvez définir les niveaux min et max des titres (ex. uniquement H2–H4). Les slugs d'ancre sont créés à partir du texte du titre et dédupliqués en cas de répétition. Pour formater le Markdown : Formateur Markdown. Pour convertir en HTML : Markdown vers HTML.

Comment utiliser cet outil

1

Coller ou télécharger du Markdown

Collez votre Markdown dans l'éditeur de gauche ou cliquez sur Télécharger pour charger un fichier .md, .markdown ou .txt. Utilisez Exemple pour charger des titres d'exemple. Le TOC se met à jour automatiquement.

2

Définir la plage de niveaux de titres

Utilisez Min H1–H4 et Max H3–H6 pour inclure uniquement certains niveaux. Par ex., Min H2 et Max H4 ignore H1 et H5–H6. Garde les docs longs focalisés.

3

Copier ou télécharger le TOC

Copiez le TOC généré dans le presse-papiers ou téléchargez-le. Collez au début de votre README ou doc. Pour le lint Markdown : Linter Markdown. Pour l'aide syntaxe : Aide-mémoire Markdown.

Quand la génération TOC aide

Les README sur GitHub, les sites de documentation et les wikis bénéficient d'un TOC. Les lecteurs peuvent sauter aux sections sans défilement. La spécification CommonMark définit la syntaxe des titres ; GFM et la plupart des moteurs de rendu prennent en charge les liens #anchor-slug. Les générateurs statiques comme Eleventy et VitePress génèrent souvent les ancres automatiquement.

Pour créer des tableaux à partir de CSV ou de données délimitées : Générateur de tableaux Markdown. Pour la référence de syntaxe : Aide-mémoire Markdown. Pour Markdown vers HTML : Markdown vers HTML.

Questions fréquentes

Comment les liens d'ancrage sont-ils générés ?

Les liens d'ancrage sont générés en convertissant le texte des titres en minuscules, en remplaçant les espaces par des tirets et en supprimant les caractères spéciaux — suivant le format d'ancrage de GitHub Flavored Markdown. Par exemple, "Premiers pas" devient #premiers-pas.

Les liens du TOC fonctionneront-ils sur GitHub ?

Oui — le format d'ancrage correspond aux conventions de GitHub Flavored Markdown, donc les liens TOC fonctionnent correctement dans les fichiers README, wikis et descriptions de pull requests GitHub.

Puis-je choisir quels niveaux de titre inclure ?

Oui — vous pouvez configurer la profondeur minimale et maximale des titres à inclure dans le TOC. Par exemple, vous pouvez inclure uniquement H2 et H3, en ignorant le titre H1 de premier niveau.

Que se passe-t-il si mes titres contiennent des caractères spéciaux ?

Les caractères spéciaux comme #, *, ? et la ponctuation sont supprimés des liens d'ancrage. Les emojis sont généralement supprimés aussi. L'outil gère cela automatiquement pour que vos liens TOC restent valides.

Outils associés

En savoir plus : CommonMark, spécification CommonMark, GitHub Flavored Markdown, Markdown Guide, GitHub, W3C HTML, Eleventy, VitePress.