Qu'est-ce qu'un générateur de table des matières Markdown ?
Un générateur de table des matières Markdown lit les titres dans un document Markdown et produit une liste imbriquée de liens qui sautent vers chaque section Vous collez votre Markdown, et l'outil renvoie un bloc prêt à l'emploi tel qu'une liste à puces où chaque ligne est un lien `[Heading] (#anchor)` Il vous évite d'écrire le contour à la main et de deviner l'identifiant d'ancrage qu'un moteur de rendu attribuera à chaque en-tête.
Le cœur de l'outil est l'ancre slug. GitHub, GitLab, et la plupart des générateurs de sites statiques transforment un en-tête comme « Getting Started » en id `ting-started` by lowcasing the text, remove ponctuation, and replacement spaces with tiphens Ce générateur applique cette même règle, y compris le suffixe numérique (`-1`, `-2`) que GitHub ajoute lorsque deux en-têtes partagent un slug, donc les liens qu'il produit résolvent aux id exacts que votre README ou page dossés rendront. Il lit les deux en-titres ATX (lignes) image (texte)
Tout s'exécute dans votre navigateur Le Markdown que vous collez est analysé avec JavaScript côté client et ne quitte jamais votre appareil, il n'y a donc pas de téléchargement, pas de compte et pas de suivi de votre contenu L'outil fonctionne hors ligne une fois la page chargée, vous permet de choisir les niveaux de titre à inclure, de basculer entre les listes à puces et numérotées et de contrôler l'indentation, et il met à jour le plan au moment où vous modifiez une option.
Comment utiliser le Générateur de TOC Markdown ?
Collez votre démarque
Déposez votre document Markdown complet ou README dans la zone de saisie Les titres à l'intérieur des blocs de code clôturés sont sautés automatiquement.
Choisissez les niveaux de cap
Définissez les niveaux les moins profonds et les plus profonds pour inclure Un choix courant est H2 à H3, qui maintient le contour lisible sans répertorier chaque sous-section.
Choisissez le style de liste
Basculez entre une liste à puces ou numérotée, activez ou désactivez les liens d'ancrage et sélectionnez une indentation à deux espaces, quatre espaces ou tabulation.
Copier la table des matières
Copiez le Markdown généré et collez-le près du haut de votre document Chaque entrée renvoie à l'ancre de titre correspondante.
Principales caractéristiques
Ancrages compatibles GitHub
Slugs correspond aux identifiants rendus par GitHub, y compris les suffixes numériques pour les titres en double, de sorte que chaque lien se résout correctement.
Filtrage de niveau
Incluez uniquement les niveaux de cap que vous souhaitez La nidification est mesurée à partir du cap inclus le moins profond, donc une liste qui commence à H2 reste à fleur à gauche.
Commandé ou non ordonné
Sortir une liste à puces ou une liste numérotée avec des compteurs par niveau, avec des liens d'ancrage optionnels et une indentation configurable.
Code-Block Conscient
Les titres écrits à l'intérieur des blocs de code clôturés sont ignorés, de sorte que les extraits d'exemple ne s'infiltrent jamais dans votre contour.
Frequently Asked Questions
Related Tools
HTML Table Generator
Generate an accessible HTML table from pasted CSV or tab-separated data. Add a header row, caption, striped rows, and borders, then copy the HTML and CSS. Runs client-side.
HTML to Markdown
Convert HTML to clean Markdown instantly. Turns headings, lists, links, images, blockquotes, code blocks and tables into portable GitHub Flavored Markdown. Tolerant of messy CMS markup. Runs client-side.
Markdown to HTML
Convert Markdown to clean, semantic HTML with GitHub Flavored Markdown support - tables, task lists, fenced code, heading anchors, live preview and a full HTML document export.
WordPress Readme Generator
Write a plugin readme.txt the WordPress.org directory parses, with a live preview of the listing it produces and a download when it is right.
Comments
0 comments
No comments yet. Be the first to share your thoughts!