markdown-toc

The markdown-toc skill is a powerful tool designed to automatically generate and manage Table of Contents (TOC) in markdown files. It solves the problem of manually creating or updating TOCs in markdown documents by automating the process. Whether you're working on a single file or multiple files, this tool saves time by streamlining TOC generation, ensuring consistency and accuracy. The skill is ideal for projects that include long markdown files with multiple sections, where keeping track of the structure and providing navigation is essential for the reader's experience.

This skill offers various customization options such as selecting header levels, choosing insertion modes, and processing files recursively. It supports single-file and batch processing with glob patterns, allowing you to handle many markdown files at once. You can configure the TOC title, control which header levels to include, and even preview the changes before committing them. The insertion modes give flexibility, with options like inserting at the top of the file, replacing an existing TOC, or inserting it between custom markers. Additionally, the tool ensures compatibility with popular platforms, generating GitHub-friendly anchor links.

This tool is particularly useful for technical documentation writers, developers, or anyone working with markdown files who needs to automate the creation of TOCs. It's a great choice for those managing large repositories with multiple markdown files or for individuals looking to maintain consistency across their markdown documents without manual intervention.