Table des matières Markdown

Ajouter automatiquement une table des matières avec liens aux fichiers Markdown

Les longs fichiers README et les wikis internes rencontrent le même problème : le lecteur doit tout parcourir avant de trouver la section dont il a besoin. Si vous avez déjà ouvert un long fichier Markdown en souhaitant qu'il commence par un plan cliquable, Table des matières Markdown en crée une pour vous.

Vous lui fournissez un seul fichier Markdown, et il lit chaque titre, transforme chacun en lien, puis insère cette liste près du début, dans un nouveau fichier que vous pouvez télécharger. L'option intitulée Inclure les titres jusqu'au niveau vous permet de choisir 2, 3 ou 4 ; la valeur par défaut de 3 capture généralement les sections principales et leurs sous-sections sans inclure chaque petit titre. Les liens suivent le style d'ancrage Markdown standard, ils fonctionnent donc de la même manière dans un dépôt de code ou un site statique.

Le traitement s'effectue sur les serveurs du site via une connexion sécurisée, et le fichier est supprimé dans les soixante minutes, si bien que rien ne subsiste ensuite. L'outil se contente de construire le plan ; il ne renumérote pas vos titres et ne corrige pas ceux qui sautent un niveau, une structure de titres irrégulière produit donc une table des matières irrégulière. Corrigez d'abord les titres si le résultat semble incorrect, puis relancez l'opération.

L'utilisation est gratuite dans la limite d'un quota quotidien, et un compte gratuit supprime ce plafond. L'outil fonctionne depuis un navigateur, sur ordinateur ou sur téléphone, sans rien à installer.