update-markdown-file-index

Generate or update markdown file indexes with relative path links.

Updated Nov 21, 2025
One-click install
npx skills add https://github.com/lluppesms/dadabase.demo --skill update-markdown-file-index-lluppesms
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-markdown-file-index
Source: https://github.com/lluppesms/dadabase.demo/tree/main/.github/skills/update-markdown-file-index
Command: npx skills add https://github.com/lluppesms/dadabase.demo --skill update-markdown-file-index-lluppesms

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the process of creating and updating an index or table of files within a Markdown document, saving manual effort and ensuring accuracy.

Core Features & Use Cases

  • Automated File Indexing: Generates lists or tables of files from a specified folder directly within a Markdown file.
  • Dynamic Updates: Can update existing indexes or create new ones, adapting to changes in the file system.
  • Use Case: Maintain an up-to-date list of all example scripts in your project's README file by automatically generating a table of files from the examples/scripts/ directory.

Quick Start

Update the markdown file 'README.md' with an index of files from the folder 'docs/api'.

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 markdown index of files from a folder?

To generate a markdown file index, this skill discovers files in a specified folder and formats them into lists or tables. It then updates your target markdown document with relative path links, preserving existing syntax.

Can I update an existing file index in a markdown document without breaking formatting?

Yes, you can update an existing file index in a markdown document without breaking formatting. The skill analyzes existing structures, updates target sections, and preserves surrounding markdown syntax while generating relative file paths.

What is the best way to keep a README file list of scripts synced with a directory?

The best way to keep a README file list synced with a directory is automated indexing. This skill dynamically updates existing markdown sections or creates new ones by scanning your target folder for current files.

Does the markdown file indexing skill support generating tables instead of lists?

Yes, the markdown file indexing skill supports generating tables instead of lists. It analyzes your specified folder and generates appropriate markdown formatting for either lists or tables using relative paths for file links.

When should I use automated markdown indexing instead of manually linking files?

You should use automated markdown indexing instead of manually linking files when maintaining large or frequently changing directories. It saves manual effort, ensures link accuracy with relative paths, and dynamically updates existing markdown sections.

Can I use this markdown indexing script for any folder in my project?

Yes, you can use this markdown indexing script for any folder in your project. It requires no external dependencies and accepts a specified folder path to discover files and generate formatted markdown links in your target document.