jonschlinkert/markdown-toc
Markdown Toc
Markdown-toc is a utility for generating and maintaining tables of contents within markdown files. It functions as both a command-line interface and a programmatic library, enabling the automated creation of structured navigation links based on the heading hierarchy of a document.
The tool distinguishes itself through its marker-based injection system, which allows for the precise placement and updating of navigation blocks within existing files. It includes a dedicated transformation pipeline for slugifying heading text into URL-friendly identifiers, ensuring that generated links remain consistent and functional as documentation evolves.
Beyond basic generation, the project provides a suite of parsing utilities that extract heading metadata and hierarchy levels. These features support custom documentation workflows, including the ability to filter content, apply depth constraints, and integrate with various markdown rendering engines to facilitate automated documentation maintenance.
Features
- Table of Contents Generators - Generates and injects structured table of contents navigation links based on document heading hierarchy.
- Document Parsing CLI Tools - Provides a command-line interface for automating table of contents maintenance using configurable insertion markers.
- Automatic Table of Contents - Injects generated tables of contents into markdown files using comment markers to define precise insertion points.
- Marker-Based Injection Utilities - Uses marker-based injection to precisely place and update generated content blocks within existing markdown files.
- Slugification Tools - Provides a transformation pipeline for slugifying heading text into URL-friendly identifiers for consistent link generation.
- Hierarchy Traversers - Implements recursive traversal of heading hierarchies to calculate nesting levels for structured navigation.
- README Section Injections - Automates the injection and refreshing of table of contents sections within project README files.
- Markdown Documentation - Maintains markdown documentation by automating the creation and updating of navigation structures.
- Utility Tools - Tool for generating tables of contents for Markdown files.
