update-markdown-file-index▌
github/awesome-copilot · updated Apr 8, 2026
Generate and maintain file indexes in markdown documents by scanning folders and updating or creating organized file listings.
- ›Scans target markdown files and discovers files matching specified patterns in designated folders
- ›Generates three table format options: simple lists with descriptions, detailed tables with type/size metadata, or categorized sections grouped by file type
- ›Automatically identifies existing index sections by heading patterns (\"index\", \"files\", \"contents\") a
Update Markdown File Index
Update markdown file ${file} with an index/table of files from folder ${input:folder}.
Process
- Scan: Read the target markdown file
${file}to understand existing structure - Discover: List all files in the specified folder
${input:folder}matching pattern${input:pattern} - Analyze: Identify if an existing table/index section exists to update, or create new structure
- Structure: Generate appropriate table/list format based on file types and existing content
- Update: Replace existing section or add new section with file index
- Validate: Ensure markdown syntax is valid and formatting is consistent
File Analysis
For each discovered file, extract:
- Name: Filename with or without extension based on context
- Type: File extension and category (e.g.,
.md,.js,.py) - Description: First line comment, header, or inferred purpose
- Size: File size for reference (optional)
- Modified: Last modified date (optional)
Table Structure Options
Choose format based on file types and existing content:
Option 1: Simple List
## Files in ${folder}
- [filename.ext](path/to/filename.ext) - Description
- [filename2.ext](path/to/filename2.ext) - Description
Option 2: Detailed Table
| File | Type | Description |
|---|---|---|
| filename.ext | Extension | Description |
| filename2.ext | Extension | Description |
Option 3: Categorized Sections
Group files by type/category with separate sections or sub-tables.
Update Strategy
- 🔄 Update existing: If table/index section exists, replace content while preserving structure
- ➕ Add new: If no existing section, create new section using best-fit format
- 📋 Preserve: Maintain existing markdown formatting, heading levels, and document flow
- 🔗 Links: Use relative paths for file links within the repository
Section Identification
Look for existing sections with these patterns:
- Headings containing: "index", "files", "contents", "directory", "list"
- Tables with file-related columns
- Lists with file links
- HTML comments marking file index sections
Requirements
- Preserve existing markdown structure and formatting
- Use relative paths for file links
- Include file descriptions when available
- Sort files alphabetically by default
- Handle special characters in filenames
- Validate all generated markdown syntax
Discussion
Product Hunt–style comments (not star reviews)- No comments yet — start the thread.
Ratings
4.5★★★★★29 reviews- ★★★★★Ishan Rao· Dec 12, 2024
update-markdown-file-index is among the better-maintained entries we tried; worth keeping pinned for repeat workflows.
- ★★★★★Ren Patel· Dec 4, 2024
Useful defaults in update-markdown-file-index — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.
- ★★★★★Neel Tandon· Nov 23, 2024
We added update-markdown-file-index from the explainx registry; install was straightforward and the SKILL.md answered most questions upfront.
- ★★★★★Noor Jain· Nov 3, 2024
Keeps context tight: update-markdown-file-index is the kind of skill you can hand to a new teammate without a long onboarding doc.
- ★★★★★Noor Diallo· Oct 22, 2024
I recommend update-markdown-file-index for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.
- ★★★★★Ira Sharma· Oct 14, 2024
update-markdown-file-index reduced setup friction for our internal harness; good balance of opinion and flexibility.
- ★★★★★Piyush G· Sep 21, 2024
Keeps context tight: update-markdown-file-index is the kind of skill you can hand to a new teammate without a long onboarding doc.
- ★★★★★Ishan Srinivasan· Sep 21, 2024
update-markdown-file-index has been reliable in day-to-day use. Documentation quality is above average for community skills.
- ★★★★★Charlotte Mensah· Sep 5, 2024
update-markdown-file-index fits our agent workflows well — practical, well scoped, and easy to wire into existing repos.
- ★★★★★Naina Mehta· Sep 1, 2024
Useful defaults in update-markdown-file-index — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.
showing 1-10 of 29