skills.rest
GDSDN
GDSDNCOMMUNITY
Explore all skills by this author →
GitHub

index-docs

Scan markdown and text files to generate a hierarchical documentation index.

3|Updated Feb 7, 2026
Search Tags:#automation#documentation#markdown#indexing#file management#link validation
One-click install
npx skills add https://github.com/GDSDN/kord-aios --skill index-docs-gdsdn
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: index-docs
Source: https://github.com/GDSDN/kord-aios/tree/main/src/features/builtin-skills/kord-aios/documentation/index-docs
Command: npx skills add https://github.com/GDSDN/kord-aios --skill index-docs-gdsdn

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of maintaining a central documentation index, ensuring all markdown and text files are correctly cataloged and linked, thus preventing broken links and improving discoverability.

Core Features & Use Cases

  • Automated Indexing: Scans the docs/ directory and subfolders to create and update a docs/index.md file.
  • Hierarchical Organization: Organizes documents by folder structure, creating sections for subdirectories.
  • Broken Link Detection: Identifies and flags entries that point to non-existent files, offering options for resolution.
  • Use Case: After adding new documentation files to your project, run this Skill to automatically update the main documentation index, ensuring new content is discoverable and all links remain valid.

Quick Start

Run the index-docs skill to update the documentation index for the project.

Frequently Asked Questions about index-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate a documentation index for markdown files?▼

To automatically generate a documentation index for markdown files, this Skill scans your specified directory structure, extracts titles and descriptions, and organizes documents hierarchically into an index.md file with valid relative links.

What is the best way to maintain a hierarchical file structure for project documentation?▼

Maintaining a hierarchical file structure for project documentation involves scanning subdirectories to automatically catalog text files, ensuring new content is organized by folder structure and linked correctly within a central index.

How do I detect and fix broken markdown links in my documentation directory?▼

Detecting and fixing broken markdown links involves scanning the documentation directory to identify entries pointing to non-existent files, then using user-interactive resolution options to correct or remove the invalid links.

Can I use this automated indexing tool for text files in my project's docs folder?▼

Yes, you can use this automated indexing tool for text files in your project's docs folder. It parses both markdown and text files, traversing the file system to catalog documents and extract descriptions for the index.

What are the limitations of automated link validation for markdown documentation?▼

Limitations of automated link validation include relying on file system traversal to detect broken links, meaning it only validates relative paths within the specified directory structure and requires user interaction to resolve flagged entries.

Related Skills

Explore More Content & Communication Skills→
laraxotlaraxot
26

bmad-index-docs

Generate or update an index.md file listing all documents in a directory.

Official
Intermediate
microsoftmicrosoft
2.9k

wiki-vitepress

Package wiki Markdown into a VitePress static site with dark theme and Mermaid diagrams.

Official
Advanced
auldsyababuaauldsyababua
6

markdown-validation

Validate Markdown files for syntax, links, and formatting standards.

Community
Advanced
angrybeaglesangrybeagles

fumadocs

Generate meta.json navigation files from blog-structure.ts for Fumadocs.

Community
Intermediate