skills.rest
ultraviollettnympho
ultraviollettnymphoCOMMUNITY
Explore all skills by this author →
GitHub

update-markdown-file-index

Generates and updates file index tables in markdown documents from folder contents.

1|1|Updated Jan 29, 2026
Search Tags:#documentation#markdown#readme#generate#table of contents#file index#folder scan
One-click install
npx skills add https://github.com/ultraviollettnympho/transit-ticket --skill update-markdown-file-index-ultraviollettnympho
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-markdown-file-index
Source: https://github.com/ultraviollettnympho/transit-ticket/tree/main/.github/skills/update-markdown-file-index
Command: npx skills add https://github.com/ultraviollettnympho/transit-ticket --skill update-markdown-file-index-ultraviollettnympho

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping file indexes and tables of contents in markdown documentation synchronized with actual folder contents is tedious manual work that quickly becomes outdated as files are added, renamed, or removed. ## Core Features & Use Cases - Automatic File Discovery: Scans a specified folder with pattern matching to list all relevant files. - Flexible Output Formats: Generates simple lists, detailed tables with type and description columns, or categorized sections grouped by file type. - Smart Section Detection: Identifies existing index sections by headings, tables, or HTML comments and updates them in place while preserving surrounding structure. - Use Case: A documentation maintainer adds several new guide files to a docs folder and needs the README index table refreshed with links and descriptions for each file. ## Quick Start Update the file index section in README.md with a table of all files from the docs folder.

Frequently Asked Questions about update-markdown-file-index

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I auto-generate a file index in a markdown file?▼

Specify the target markdown file and the folder to scan, and the skill lists all matching files, extracts names and descriptions, then inserts or updates a formatted index section with relative links sorted alphabetically.

How to update an existing table of contents in markdown documentation?▼

The skill detects existing index sections by looking for headings containing words like index, files, or contents, as well as file-related tables and lists. It replaces the section content while preserving the original structure and formatting.

What output formats does markdown file indexing support?▼

Three formats are supported: a simple bulleted list with links and descriptions, a detailed table with file, type, and description columns, and categorized sections that group files by type with separate sub-tables.

Does the file index preserve existing markdown formatting?▼

Yes, the update strategy preserves existing heading levels, document flow, and markdown syntax. It uses relative paths for links, handles special characters in filenames, and validates all generated markdown before writing.

Can I filter which files appear in the markdown index?▼

Yes, file discovery accepts a pattern parameter that filters which files in the target folder are included in the generated index, so you can limit the listing to specific extensions or naming conventions.

Related Skills

Explore More Software Engineering Skills→
Paxeer-NetworkPaxeer-Network
3

storage-function-structure

Organizes project planning documents into standardized, categorized directories with consistent naming conventions.

Official
Basic
bordenetbordenet
8

link-verification

Validate and verify Markdown links in documentation before publishing.

Community
Advanced
NSEvteevNSEvteev
31

links-validate

Validate and fix broken links between Markdown documents.

Community
Intermediate
arthur0narthur0n
8

godot-greybox

Build static Godot level blockouts with real scene nodes in .tscn files.

Community
Advanced