SkillHub

Skills github awesome-copilot

update-markdown-file-index

Use it when:
A README or docs page should list a folder's files and you want that list written or brought up to date.
It does:
Lists files matching a pattern, takes each one's description from its first comment or heading, and finds an existing index section.
You get:
The section replaced or a new one added, as a simple list, a table or grouped sections, with relative links sorted alphabetically.
Inputs:
The Markdown file, the folder and a file pattern.

TL;DR

A small maintenance command for file indexes in docs. You give it a Markdown file, a folder and a file pattern. The agent reads the file's structure, lists the matching files, and for each takes its name, type and a description from its first-line comment or header, or infers one, with size and last-modified date as options. It looks for an existing index: a heading containing words such as index, files, contents or directory, a table with file columns, a list of file links, or HTML comments marking the section. If it finds one it replaces the contents and keeps the structure; otherwise it adds a new section in the best-fitting format: a simple list, a detailed table or sections grouped by type. Links are relative, files sort alphabetically by default, and it keeps the document's headings and formatting and checks that the Markdown is valid.

Summarizes the skill at 797337f.

npx skills add https://github.com/github/awesome-copilot --skill update-markdown-file-index

skills.sh pageSource on GitHubAll skills from github/awesome-copilot

Total Downloads
8,900 on skills.sh, Nov 9, 2026
Repo stars
40,943 github/awesome-copilot
First seen
Feb 25, 2026 on skills.sh
Weekly Downloads
0
-100% over the 8 weeks to Nov 9
Weekly values
Week toInstalls
Sep 2112
Sep 2818
Oct 517
Oct 126
Oct 190
Oct 264
Nov 25
Nov 90
Category
category:writing

Articles, docs, internal comms, research write-ups and prose that doesn't read as generated.
Type
type:command

A one-shot action you invoke by name, such as turning the conversation into a PRD.
Effect
effect:local

Its own steps create or change files, git state or local tools.
Needs
needs:none

Instructions only. Works in any agent that supports skills.
Publisher
by:official

A verified publisher on skills.sh, or the company or maintainer behind the product the skill operates.
Topics
docs-writing

SKILL.md

From github/awesome-copilot at 797337f. Checked daily, last changed Nov 6, 2026.

Frontmatter
name: update-markdown-file-index
description: 'Update a markdown file section with an index/table of files from a specified folder.'

Update Markdown File Index

Update markdown file ${file} with an index/table of files from folder ${input:folder}.

Process

  1. Scan: Read the target markdown file ${file} to understand existing structure
  2. Discover: List all files in the specified folder ${input:folder} matching pattern ${input:pattern}
  3. Analyze: Identify if an existing table/index section exists to update, or create new structure
  4. Structure: Generate appropriate table/list format based on file types and existing content
  5. Update: Replace existing section or add new section with file index
  6. Validate: Ensure markdown syntax is valid and formatting is consistent

File Analysis

For each discovered file, extract:

  • Name: Filename with or without extension based on context
  • Type: File extension and category (e.g., .md, .js, .py)
  • Description: First line comment, header, or inferred purpose
  • Size: File size for reference (optional)
  • Modified: Last modified date (optional)

Table Structure Options

Choose format based on file types and existing content:

Option 1: Simple List
## Files in ${folder}

- [filename.ext](path/to/filename.ext) - Description
- [filename2.ext](path/to/filename2.ext) - Description
Option 2: Detailed Table
| File | Type | Description |
|------|------|-------------|
| [filename.ext](path/to/filename.ext) | Extension | Description |
| [filename2.ext](path/to/filename2.ext) | Extension | Description |
Option 3: Categorized Sections

Group files by type/category with separate sections or sub-tables.

Update Strategy

  • 🔄 Update existing: If table/index section exists, replace content while preserving structure
  • ➕ Add new: If no existing section, create new section using best-fit format
  • 📋 Preserve: Maintain existing markdown formatting, heading levels, and document flow
  • 🔗 Links: Use relative paths for file links within the repository

Section Identification

Look for existing sections with these patterns:

  • Headings containing: "index", "files", "contents", "directory", "list"
  • Tables with file-related columns
  • Lists with file links
  • HTML comments marking file index sections

Requirements

  • Preserve existing markdown structure and formatting
  • Use relative paths for file links
  • Include file descriptions when available
  • Sort files alphabetically by default
  • Handle special characters in filenames
  • Validate all generated markdown syntax