polyshGénérateur de table des matières Markdown
Obtenez une table des matières imbriquée et cliquable pour n’importe quel document Markdown.
- Fonctionne dans votre navigateur
- Aucun envoi de fichier
- Aucun compte
Chargement de l'outil dans votre navigateur…
Ce que fait Générateur de table des matières Markdown
Un long README, une SOP ou un guide d’administration a besoin d’un sommaire en haut, et le tenir à jour à la main est source d’erreurs. Collez tout le document : le générateur lit chaque titre, y compris les titres soulignés par === et ---, puis écrit une liste imbriquée de liens qui mènent à chaque section.
Choisissez la profondeur avec « Inclure jusqu’à », du H2 seul à tous les niveaux. Un titre H1 unique est exclu par défaut, car il nomme généralement le document lui-même. Activez « Table des matières numérotée » pour un plan en 1., 2., 3., qui sert aussi de carte rapide des titres quand vous restructurez un document.
Exemple
Entrée
# Manuel de l’enregistreur ## Avant d’enregistrer ### Test du micro (2 min) ## Montage ### Couper les pauses ## Montage #### Raccourcis clavier
Résultat
- [Avant d’enregistrer](#avant-denregistrer) - [Test du micro (2 min)](#test-du-micro-2-min) - [Montage](#montage) - [Couper les pauses](#couper-les-pauses) - [Montage](#montage-1)
Le titre H1 est exclu, le H4 se trouve sous la profondeur H3 par défaut, les parenthèses et l’apostrophe disparaissent des ancres, et le second titre Montage pointe vers #montage-1.
Mode d'emploi : Générateur de table des matières Markdown
- Collez le document Markdown complet, ou cliquez sur « Ouvrir un fichier » pour charger un fichier .md.
- Choisissez un niveau sous « Inclure jusqu’à » ; « Plus d’options » contient « Exclure un titre H1 unique » et « Table des matières numérotée ».
- Cliquez sur « Copier » ou « Télécharger le .md », puis collez la liste sous le titre de votre document.
Bon à savoir
- GitLab, Bitbucket, Docusaurus et d’autres moteurs de rendu peuvent construire les id autrement que GitHub pour les titres avec ponctuation ou lettres non latines : testez quelques liens sur place.
- Les titres à l’intérieur du code délimité sont ignorés, comme il se doit, mais les titres écrits en HTML brut comme
<h2>ne sont pas repris non plus. - La liste est un instantané. Quand vous renommez ou ajoutez des titres, générez-la de nouveau ; rien ne la met à jour.
Questions sur Générateur de table des matières Markdown
Comment ajouter une table des matières à un README GitHub ?
Collez le README ici, copiez la liste générée et collez-la sous le titre. Chaque entrée renvoie vers une ancre que GitHub crée pour le titre correspondant. GitHub propose aussi un menu de plan pour les README, mais une liste dans le fichier fonctionne dans toutes les visionneuses.
Pourquoi un lien du sommaire ne mène-t-il pas à son titre ?
En général, le titre a changé après la création de la liste, ou votre site construit les ancres autrement que GitHub. Régénérez la liste à partir du texte actuel, et comparez une ancre avec l’id que votre site attribue réellement à ce titre.
Une table des matières doit-elle inclure les titres H4 ?
En général non. Les lecteurs parcourent les sections H2, et le H3 apporte assez de détail pour les longs guides. Aller plus loin rend la liste plus longue que le contenu qu’elle résume : gardez le H3 par défaut et ne choisissez H4 ou « Tous » que pour la documentation de référence.
Puis-je numéroter la table des matières ?
Oui. Activez « Table des matières numérotée » dans « Plus d’options ». Chaque niveau est numéroté à partir de 1 et indenté de trois espaces, ce qui s’affiche comme une liste ordonnée imbriquée.