Générateur de table des matières Markdown
Générez une table des matières pour un document Markdown. Collez un README ou une page de documentation, choisissez les niveaux de titre à inclure et obtenez une liste imbriquée avec des liens vers l’ancre de chaque titre, formée comme GitHub crée les identifiants de titre. Les titres dans les blocs de code sont ignorés et les titres en double reçoivent des ancres numérotées.
Foire aux questions
Comment les liens d’ancrage sont-ils créés ?
De la même manière que GitHub crée les identifiants de titre : le texte du titre passe en minuscules, la ponctuation et les symboles sont supprimés, et les espaces deviennent des traits d’union. Getting Started devient #getting-started et C++ & Rust devient #c--rust.
Que se passe-t-il lorsque des titres apparaissent plusieurs fois ?
Comme sur GitHub, l’ancre du deuxième titre portant le même texte reçoit le suffixe -1, celle du troisième -2, et ainsi de suite ; chaque lien mène donc à la bonne section.
Quels titres sont reconnus ?
Les titres ATX qui commencent par un à six caractères # et les titres setext soulignés par = ou -. Les titres dans les blocs de code délimités, le code indenté et le front matter YAML sont ignorés.
Comment le formatage à l’intérieur des titres est-il traité ?
Les liens ne conservent que leur texte, le code en ligne perd ses accents graves, les marqueurs d’emphase et les balises HTML sont supprimés, et les images sont éliminées. Le texte de l’entrée et l’ancre sont tous deux formés à partir de ce texte brut.
Quels niveaux de titre sont inclus ?
Les niveaux 2 et 3 par défaut, car le titre de niveau 1 correspond généralement au titre du document. Définissez le niveau le plus bas et le plus haut, de 1 à 6. La liste est indentée par rapport au niveau le plus élevé trouvé.
Puis-je obtenir une liste numérotée ou du texte brut ?
Oui. Choisissez une liste numérotée pour obtenir 1., 2. et une numérotation imbriquée, ou désactivez les liens pour n’afficher que les textes des titres, par exemple pour un plan imprimé.