Markdown File Indexer
Automates the generation and updating of file indices and directory tables within Markdown documentation.
The update-markdown-file-index skill is a specialized utility designed to keep project documentation in sync with the actual file system. It automatically scans specified directories, discovers files matching specific patterns, and generates structured tables or lists within Markdown files. By extracting metadata such as file descriptions from comments and headers, it ensures that READMEs and documentation pages remain accurate and informative without manual intervention. This skill is particularly useful for large-scale repositories where keeping a manual directory of tools, scripts, or assets is time-consuming and error-prone.
主要功能
01Support for multiple formats including detailed tables and categorized lists
0218 GitHub stars
03Automatic extraction of file descriptions from source code headers
04Automatic directory scanning with customizable pattern matching
05Intelligent identification and replacement of existing index sections
06Validation of generated Markdown syntax and relative link consistency
使用场景
01Maintaining an auto-updating 'Available Tools' table in a project README
02Generating a table of contents for documentation folders containing many sub-files
03Listing all scripts or source files in a repository with metadata and relative links