ekalinin/github-markdown-toc
Github Markdown Toc
Ce projet est un utilitaire en ligne de commande conçu pour automatiser la création et la maintenance des tables des matières dans les fichiers Markdown. Il fonctionne comme un processeur de documentation statique qui analyse les titres des documents pour générer des listes de navigation hiérarchiques, lesquelles sont ensuite injectées directement dans les fichiers sources.
L'outil se distingue par sa prise en charge des fichiers locaux et des flux réseau distants comme sources d'entrée. Il utilise une mise à jour de contenu basée sur des marqueurs pour rafraîchir les sections de navigation existantes sans nécessiter d'éditions manuelles, et inclut un support d'authentification pour les requêtes distantes afin de contourner les limites de débit lors de la récupération de documentation externe.
Au-delà de la génération de base, l'utilitaire gère la normalisation des titres en slugs d'ancrage compatibles avec les URL et gère les métadonnées structurelles nécessaires à une indexation cohérente des documents. Il vise à rationaliser les flux de travail de documentation en automatisant la maintenance des structures de navigation dans les fichiers du dépôt et les contenus techniques distribués.
Features
- Automatic Table of Contents - Automatically generates, inserts, and refreshes formatted tables of contents by parsing document headings.
- Marker-Based Injection Utilities - Maintains persistent navigation sections by injecting content between predefined start and end markers in source files.
- Table of Contents Generators - Parses markdown files via command-line to create and inject hierarchical navigation lists based on headings.
- Hierarchical Heading Generation - Calculates indentation levels and generates URL-safe anchor slugs to structure document headings into a hierarchical tree.
- Markdown Documentation - Automates the creation and updating of table of contents sections within markdown files to improve navigation.
- README Generators - Automates the maintenance of navigation structures within repository documentation files to improve reader accessibility.
- GitHub Repository Utilities - Provides utilities to generate structured navigation lists for project README files in GitHub repositories.
- Static Documentation Generators - Acts as a text-parsing engine that extracts document structure from various sources to generate formatted navigation links.
