Points clés
- Catégorie
- Conversion et encodage
- Types d’entrée
- textarea, select, checkbox
- Type de sortie
- text
- Couverture des échantillons
- 4
- API disponible
- Yes
Vue d’ensemble
Le Générateur de TOC Markdown vous permet de créer instantanément une table des matières structurée à partir de vos documents Markdown. En analysant vos titres de H1 à H6, cet outil génère un plan clair avec des liens d'ancrage compatibles avec le style GitHub, facilitant ainsi la navigation au sein de vos fichiers de documentation ou articles de blog.
Quand l’utiliser
- •Lors de la rédaction d'une documentation technique ou d'un fichier README volumineux sur GitHub.
- •Pour structurer un long article de blog rédigé en Markdown avant sa publication.
- •Pour ajouter rapidement des liens d'ancrage internes et améliorer l'accessibilité de vos pages web statiques.
Comment ça marche
- •Collez votre texte Markdown contenant des titres dans le champ de saisie prévu à cet effet.
- •Configurez les options de génération, telles que les niveaux de titre minimum et maximum, le style de liste et le format de sortie.
- •Récupérez la table des matières générée automatiquement avec ses ancres de navigation au format Markdown ou HTML.
Cas d’usage
Exemples
1. Sommaire pour un README GitHub
Développeur Open Source- Contexte
- Un développeur maintient un projet avec un fichier README.md très long contenant de nombreuses sections techniques.
- Problème
- Les utilisateurs ont du mal à naviguer dans le document sans table des matières interactive.
- Comment l’utiliser
- Coller le contenu du README dans l'outil, définir le niveau minimum à H2 et le niveau maximum à H3, puis activer les liens d'ancrage.
- Configuration d’exemple
-
Niveau de Titre Minimum: H2, Niveau de Titre Maximum: H3, Style de Liste: Unordered, Inclure les Liens d'Ancrage: Oui - Résultat
- Une liste à puces imbriquée contenant des liens directs vers chaque section H2 et H3 du README.
2. Table des matières HTML pour un blog statique
Rédacteur Web- Contexte
- Un rédacteur prépare un guide complet rédigé en Markdown pour un site généré avec un outil statique.
- Problème
- Le site requiert un sommaire au format HTML pur pour s'intégrer correctement dans le modèle de page.
- Comment l’utiliser
- Insérer le texte Markdown, choisir le format de sortie HTML et configurer l'indentation sur 4 Spaces.
- Configuration d’exemple
-
Format de Sortie: HTML, Style d'Indentation: 4 Spaces, Emballer dans un Bloc de Code: Non - Résultat
- Une structure de liste HTML avec des balises d'ancrage prêtes à être insérées dans le code source du site.
Tester avec des échantillons
markdown, barcodeHubs associés
FAQ
Quels formats de sortie sont disponibles ?
L'outil peut générer la table des matières au format Markdown, HTML, ou les deux combinés.
Comment sont créés les liens d'ancrage ?
Ils sont générés au format standard de GitHub, transformant les titres en minuscules et remplaçant les espaces par des tirets.
Puis-je limiter la profondeur de la table des matières ?
Oui, vous pouvez définir précisément les niveaux de titre minimum (ex. H2) et maximum (ex. H4) à inclure.
L'outil prend-il en charge les listes ordonnées ?
Oui, vous pouvez choisir entre un style de liste non ordonnée (puces) ou ordonnée (numérotée).
Qu'est-ce que l'option d'emballage dans un bloc de code ?
Elle permet d'entourer la table des matières générée dans un bloc de code Markdown pour faciliter son copier-coller sans interprétation immédiate.