index-generator

Generate INDEX.md by aggregating YAML Front Matter from Markdown files.

Updated Jan 16, 2026
One-click install
npx skills add https://github.com/kumewata/dotfiles --skill index-generator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: index-generator
Source: https://github.com/kumewata/dotfiles/tree/main/config/agents/skills/index-generator
Command: npx skills add https://github.com/kumewata/dotfiles --skill index-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scans Markdown files with YAML Front Matter to automatically generate an INDEX.md that surfaces a project list, a tag index, and a keyword index for fast doc-search access.

Core Features & Use Cases

  • Build a project list ordered by last update
  • Create tag and keyword indexes to speed up Level 1 search
  • Automatically generate or refresh INDEX.md to keep large docs navigable
  • Use case: after adding or updating docs, run the skill to refresh the index for immediate search results

Quick Start

Run the index-generator against your docs directory to produce PATH/INDEX.md

Frequently Asked Questions about index-generator

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

FAQPage Schema
How do I automatically generate an index for my Markdown documentation?

Automatically generate an index for Markdown documentation by scanning YAML Front Matter to produce an INDEX.md, surfacing project lists, tag indexes, and keyword indexes for fast search access. Run the tool against your docs directory to output the file atomically.

What is YAML Front Matter used for in doc-search indexing?

YAML Front Matter in doc-search indexing provides metadata like created_at, updated_at, tags, and keywords to categorize Markdown files. Aggregating this metadata builds ordered project lists and searchable tag indexes within a centralized INDEX.md for fast navigation.

Can I build a tag and keyword index from Markdown files without external dependencies?

You can build tag and keyword indexes from Markdown files without external dependencies. The tool reads YAML Front Matter directly to aggregate tags and keywords, writing the INDEX.md atomically to ensure large documentation collections remain navigable and searchable.

How to keep a large documentation collection navigable after adding new docs?

Keep a large documentation collection navigable after adding new docs by running periodic index refreshes. The tool aggregates updated YAML Front Matter, re-establishes ordering by updated_at or created_at, and rewrites the INDEX.md atomically for immediate search results.

What's the best way to structure Markdown documentation for fast search?

The best way to structure Markdown documentation for fast search is adding YAML Front Matter with updated_at, tags, and keywords. Aggregating this metadata automatically generates a centralized INDEX.md containing project lists and keyword indexes to speed up Level 1 search.

Does the INDEX.md generation process handle concurrent updates atomically?

The INDEX.md generation process handles updates atomically by writing the complete file in a single operation. This prevents partial reads while aggregating YAML Front Matter and rebuilding project, tag, and keyword indexes during periodic documentation maintenance.