thlorenz/doctoc
Doctoc
doctoc is a markdown table of contents generator and file processor designed to automatically create and update linked lists of headings within markdown documents. It functions as a git repository documentation tool that scans local directories to ensure navigation remains consistent across a collection of files.
The tool features a GitHub compatible anchor generator that formats heading links to match the specific requirements of GitHub and similar hosting platforms. It manages updates by locating marker comments to replace existing tables of contents without overwriting other document content.
The project covers recursive directory processing, which allows it to scan nested folders and apply updates to all compatible files. It also includes content filtering and entry control to exclude specific headings or files based on nesting levels or metadata tags.
A consistency validation utility allows the tool to check if files are out of date without modifying them, facilitating integration into automated documentation workflows.
Features
- Automatic Table of Contents - Automatically generates navigational outlines based on the heading hierarchy of Markdown documents.
- Anchor Links - Generates navigation identifiers that ensure compatibility with the anchor requirements of hosting providers.
- Markdown Processors - Provides a recursive processor that scans and transforms Markdown documents to maintain consistent navigation and formatting.
- Markdown Documentation - Automates the creation and maintenance of tables of contents for large sets of Markdown documentation.
- Platform Anchor Generators - Provides GitHub-compatible anchor generation to ensure navigation links function correctly on hosting platforms.
- TOC Refresh Utilities - Refreshes existing tables of contents by locating marker comments to prevent duplicate entries.
- Git Documentation Utilities - Scans local Git directories to ensure all Markdown files have consistent and current navigation.
- RegEx Heading Extractors - Uses regular expressions to identify heading levels and extract structure for table of contents generation.
- Markdown Content Structures - Manages navigation for complex directory structures through recursive processing and content filtering.
- Content Consistency Validators - Checks if document headings match the existing table of contents to signal required updates without modifying files.
- TOC Generation - Validates the consistency of the generated table of contents against the actual document headings.
- TOC Content Filters - Excludes specific headings or files from the generated table of contents using specialized markup tags.
- TOC Entry Controllers - Controls which headings appear in the table of contents based on nesting levels and minimum length.
- GitHub Repository Utilities - Provides utility functions to ensure Markdown navigation links are compatible with GitHub's repository structure.
- Documentation Automation - Integrates table of contents generation into build pipelines to keep navigation in sync with heading changes.
- Recursive Directory Processing - Traverses folder hierarchies to apply table of contents updates across entire project directories.
- Markdown File Processors - Recursively scans directories to apply table of contents generation to all compatible Markdown files.
- Recursive Directory Traversers - Recursively walks directory trees to locate all markdown files for batch processing.
- Marker-Based Injection Utilities - Implements programmatic updates of documentation by injecting table of contents between predefined marker comments.
- Markdown Tools - Generates table of contents for markdown files.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
