update-markdown-file-index

Generate or update file indexes and tables in a Markdown file from a folder.

Updated Dec 28, 2025
One-click install
npx skills add https://github.com/74nu5/Narratum --skill update-markdown-file-index
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-markdown-file-index
Source: https://github.com/74nu5/Narratum/tree/main/.github/skills/update-markdown-file-index
Command: npx skills add https://github.com/74nu5/Narratum --skill update-markdown-file-index

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 accuracy.

Core Features & Use Cases

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

Quick Start

Update the file '/path/to/your/README.md' with an index of all files in the '/path/to/your/assets' 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 automatically generate a markdown index of files in a folder?

To update an existing file index in markdown, this Skill scans the target markdown document for existing index sections and automatically refreshes them with the latest folder contents. It dynamically updates the file table without requiring manual edits to your documentation.

Can I format the generated file index as a table instead of a list?

You can format the generated file index as a table instead of a list because the Skill supports customizable formatting options. It allows you to generate simple lists, detailed tables, or categorized sections based on your specific markdown documentation needs.

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

The best way to create a table of contents for markdown files is to use an automated indexing script that reads directory contents and writes them into your main README. This Skill extracts file metadata and generates the directory structure automatically inside the markdown file.

Does markdown file indexing work without external dependencies?

Markdown file indexing works without external dependencies because this Skill operates with an empty dependency list. It independently scans your designated folders, extracts file metadata, and writes the generated index directly into the target markdown file.

What file metadata can I extract when generating a markdown index?

When generating a markdown index, you can extract file metadata such as the file name, file type, and file description. The Skill collects this information from the designated folder to populate the lists or tables within your markdown document.