Update markdown file index
Skill mouadja02/skills/skills/documentation/update-markdown-file-index
Update a markdown file section with an index/table of files from a specified folder.From its SKILL.md
npx -y skills add mouadja02/skills --skill update-markdown-file-indexAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 8 stars8 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
2.6 KB, 545 tokens by cl100k_base, as published. Nobody here has run it
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
What ships with it
Read from the repository
Just SKILL.md. No reference files, no scripts.
Gives 0 of the 12 instructions most docs writing skills give in 545 tokens
Counted across 1,637 of the 3,044 authors here whose files we hold, read 2026-08-07
- Announce the skill at startin 54 of 1637, across 26 files
- Convert legacy doc files before editingin 45 of 1637, across 7 files
- Predict questions readers might askin 42 of 1637, across 4 files
- Generate clarifying questions for initial contextin 42 of 1637, across 3 files
- Create document scaffold with placeholder textin 42 of 1637, across 3 files
- Brainstorm content options for each sectionin 42 of 1637, across 3 files
- Test the document with a fresh context-less instancein 42 of 1637, across 3 files
- Include exact file paths in every taskin 42 of 1637, across 15 files
- Ask interview questions one at a timein 42 of 1637, across 27 files
- Apply surgical edits during refinementin 41 of 1637, across 2 files
- Offer structured workflow or freeformin 40 of 1637, across 1 file
- Ask for document meta-contextin 40 of 1637, across 2 files
Grouped from the skills themselves: near-identical wordings counted once, and counted by distinct author, so one author publishing three of these counts once. Length counted with cl100k_base; the agent that loads this file may tokenize it differently.