update-markdown-file-index

Update a markdown file with an index of files from a folder.

1|Updated Feb 23, 2026
One-click install
npx skills add https://github.com/Gabeujin/workspace-init-mcp --skill update-markdown-file-index-gabeujin
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-markdown-file-index
Source: https://github.com/Gabeujin/workspace-init-mcp/tree/main/awesome/skills/update-markdown-file-index
Command: npx skills add https://github.com/Gabeujin/workspace-init-mcp --skill update-markdown-file-index-gabeujin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the process of creating and updating an index or table of files within a specified folder directly inside a Markdown file, saving manual effort and ensuring consistency.

Core Features & Use Cases

  • Automated Index Generation: Creates lists or tables of files from a given directory.
  • Dynamic Updates: Can update existing indexes within a Markdown file.
  • Customizable Formatting: Supports simple lists or detailed tables.
  • Use Case: Automatically generate a table of contents for all .md files in your docs/ directory within your project's main README.md.

Quick Start

Update the markdown file 'README.md' with an index of all files in the folder '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 an index of files in a markdown document?

To automatically generate a file index in markdown, you need a tool that scans a target directory for matching files and inserts their details as a list or table. This process analyzes file names and types, then inserts relative path links directly into the target document.

Can I update an existing file listing table in a markdown file without breaking formatting?

Yes, you can update an existing file listing in a markdown file without breaking formatting. The process scans the target markdown for existing index sections, dynamically updates the file entries, and preserves all surrounding markdown formatting using relative paths for links.

What is the best way to create a table of contents for markdown files in a docs folder?

Creating a table of contents for markdown files in a docs folder is best handled by automating index generation. The tool discovers files matching a pattern, analyzes their details, and outputs a structured table or simple list inside your project document.

Does automated markdown index generation support both simple lists and detailed tables?

Yes, automated markdown index generation supports both simple lists and detailed tables. You can customize the output formatting to structure discovered files as either a basic list or a comprehensive table detailing file names, types, and descriptions.

How do I scan a directory and list matching files inside a README markdown file?

To scan a directory and list matching files inside a README markdown file, you configure an automated index update. It discovers files matching your pattern within the input folder, analyzes their details, and writes the output as a list or table with relative path links.