ekalinin/github-markdown-toc
Github Markdown Toc
Este proyecto es una utilidad de línea de comandos diseñada para automatizar la creación y el mantenimiento de tablas de contenido dentro de archivos markdown. Funciona como un procesador de documentación estática que analiza los encabezados de los documentos para generar listas de navegación jerárquicas, que luego se inyectan directamente en los archivos fuente.
La herramienta se distingue por admitir tanto archivos locales como flujos de red remotos como fuentes de entrada. Utiliza la actualización de contenido basada en marcadores para refrescar las secciones de navegación existentes sin requerir ediciones manuales, e incluye soporte de autenticación para solicitudes remotas para evitar los límites de tasa de servicio al obtener documentación externa.
Más allá de la generación básica, la utilidad maneja la normalización de encabezados en slugs de anclaje seguros para URL y gestiona los metadatos estructurales necesarios para una indexación de documentos consistente. Está destinada a agilizar los flujos de trabajo de documentación automatizando el mantenimiento de las estructuras de navegación en los archivos del repositorio y el contenido técnico distribuido.
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.
