update-markdown-file-index

Update markdown file sections with indexes of folder contents.

Updated Mar 8, 2026
One-click install
npx skills add https://github.com/tamago0224/kuroshio-mta --skill update-markdown-file-index-tamago0224
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-markdown-file-index
Source: https://github.com/tamago0224/kuroshio-mta/tree/main/.agents/skills/update-markdown-file-index
Command: npx skills add https://github.com/tamago0224/kuroshio-mta --skill update-markdown-file-index-tamago0224

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeping README and documentation indexes in sync with repository folders is tedious and error-prone when done manually; this Skill automates discovery and insertion of file lists or tables so documentation stays accurate and up-to-date.

Core Features & Use Cases

  • Scans a target markdown file to detect and preserve existing structure while locating an index section to update or replace.
  • Discovers files in a specified folder using glob patterns, extracts basic metadata (name, extension, first-line description, size, modified date), and sorts results.
  • Generates appropriate list or table formats (simple list, detailed table, or categorized sections) using relative links and preserves heading levels and surrounding content.
  • Use case: Keep a docs/ directory index in README.md synchronized with new tutorial or reference files, or create a navigable file index for a project's documentation site.

Quick Start

Update README.md to replace the "Files" section with an alphabetized table of markdown files from docs/.

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 automatically generate a table of contents for markdown files in a repository folder?

To automatically generate a table of contents for markdown files, this skill scans a specified folder using glob patterns, extracts file metadata like names and descriptions, and formats the results into a list or table within your target markdown file.

What is the best way to keep a README file index synchronized with directory contents?

The best way to keep a README file index synchronized is to perform safe in-place replacement of a designated index section, preserving the surrounding markdown structure while inserting the updated directory contents.

Can I extract file descriptions and metadata when creating a markdown index?

Yes, you can extract file descriptions and metadata when creating a markdown index; the process reads basic metadata such as file name, extension, first-line description, size, and modified date to populate the generated lists or tables.

Does the markdown index update process preserve existing document structure and headings?

The markdown index update process preserves existing document structure and headings by scanning the target file to locate the specific index section, replacing only that block while keeping surrounding content and relative links intact.

How do I format directory file lists into categorized sections in markdown?

You can format directory file lists into categorized sections in markdown by specifying the desired output style, allowing the tool to sort discovered files and generate simple lists, detailed tables, or categorized sections using relative links.