DocToc

DocToc automatically generates and maintains table of contents for markdown files in your git repository. It creates clickable links that work seamlessly with GitHub and other platforms, eliminating the need to manually update navigation as your documentation grows.

Key features include:

• Automatic updates: Re-run the command to keep your TOC in sync with document changes
• Flexible configuration: Control heading levels, indentation style, and TOC title formatting
• Multi-platform support: Generate links compatible with GitHub, GitLab, Bitbucket, and other markdown renderers
• Batch processing: Update all markdown files in a directory and subdirectories at once
• Smart file handling: Skip specific files with a simple comment, or update only existing TOCs
• Customizable output: Add headers, footers, adjust padding, and choose between legacy or compact pragma styles
• Dry-run capability: Preview changes before applying them
• Git hook integration: Automate TOC generation as part of your development workflow
• Docker support: Run DocToc in containerized environments

Simply install via npm and run doctoc . in your project directory to generate professional, maintainable documentation navigation automatically.