index

Generate Markdown, YAML, or JSON index files and Markdown consistency prompts for directories.

4|2|Updated Feb 26, 2026
One-click install
npx skills add https://github.com/wojons/skills --skill index-wojons
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: index
Source: https://github.com/wojons/skills/tree/main/skills/index
Command: npx skills add https://github.com/wojons/skills --skill index-wojons

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill streamlines project navigation and consistency by creating and maintaining index files and prompt files within directories, reducing cognitive load and onboarding time.

Core Features & Use Cases

  • Directory Indexing: Automatically generate _index.md, _index.yaml, or _index.json files to document directory purpose, contents, and conventions.
  • Consistency Prompts: Create _prompt.md files to enforce naming, structure, and content standards for files within a directory.
  • Use Case: When onboarding to a new project, use this Skill to quickly understand the purpose and contents of each directory without needing to open every file.

Quick Start

Use the index skill to create markdown index files for the current directory and all subdirectories.

Frequently Asked Questions about index

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

FAQPage Schema
How do I document directory structure and contents for project onboarding?

To document directory structure for project onboarding, you can generate index files like Markdown, YAML, or JSON. This reduces cognitive load by automatically mapping out directory purpose, contents, and conventions without opening every file.

What is the best way to enforce file naming and content consistency across project directories?

The best way to enforce file naming and content consistency is by creating consistency prompt files within each directory. These prompt files enforce specific structural and content standards for any new files added to that location.

Can I generate YAML or JSON index files instead of Markdown for directory organization?

Yes, you can generate YAML or JSON index files instead of Markdown. The directory organization process supports all three formats, allowing you to document directory purpose and contents using whichever structured format fits your project.

How do I quickly understand a new codebase without opening every file?

You can quickly understand a new codebase by relying on generated index files. These files document the purpose, contents, and conventions of each directory, drastically reducing onboarding time and the need to manually inspect individual files.

How do consistency prompts work for maintaining code structure standards?

Consistency prompts maintain code structure standards by providing a markdown file that defines naming and content rules for a directory. This ensures every file created within that directory adheres to the established organizational conventions.

Do I need any specific dependencies to create index files for directory navigation?

No specific dependencies are required to create index files for directory navigation. The process operates independently to generate Markdown, YAML, or JSON indexes and prompt files without relying on external libraries or tools.