---

name: index-docs description: Index markdown documentation - headings, diagrams, tables, code blocks, links. Use for quick overview without reading full files. allowed-tools: Bash, Read

Markdown Documentation Indexer

Extract structure from markdown files without loading full content.

Quick Start

Headings (Most Common)

Copy# H1/H2 headings
find . -name "*.md" -type f -not -path "*/.git/*" | xargs grep -n "^##\? " 2>/dev/null | head -100

# H1/H2/H3 headings
find . -name "*.md" -type f -not -path "*/.git/*" | xargs grep -n "^###\?\? " 2>/dev/null | head -150

Mermaid Diagrams

Copy# Find files with mermaid diagrams
grep -rln 'mermaid' --include="*.md" . 2>/dev/null

# Show mermaid diagram types
grep -rn 'mermaid' --include="*.md" -A1 . 2>/dev/null | grep -E "(flowchart|graph|sequenceDiagram|classDiagram|erDiagram|gantt)"

Code Blocks

Copy# Find all code blocks with language
grep -rn '^```[a-z]' --include="*.md" . 2>/dev/null | head -50

# Count code blocks by language
grep -roh '^```[a-z]*' --include="*.md" . 2>/dev/null | sort | uniq -c | sort -rn

Tables

Copy# Find markdown tables (header lines)
grep -rn "^|.*|.*|$" --include="*.md" . 2>/dev/null | grep -E "\-\-\-" | head -30

Links & References

Copy# Find all links
grep -ron "\[.*\](.*)" --include="*.md" . 2>/dev/null | head -50

# Find cross-references (relative links)
grep -ron "\[.*\](\.\./.*)" --include="*.md" . 2>/dev/null | head -30

# Find external links
grep -ron "\[.*\](https://.*)" --include="*.md" . 2>/dev/null | head -30

Images

Copy# Find all images
grep -ron "!\[.*\](.*)" --include="*.md" . 2>/dev/null | head -30

YAML Frontmatter

Copy# Find files with frontmatter
grep -rln "^---$" --include="*.md" . 2>/dev/null | head -20

TODOs and FIXMEs

Copy# Find action items in docs
grep -rn "TODO\|FIXME\|XXX\|\[ \]" --include="*.md" . 2>/dev/null | head -30

Filtered Searches

Copy# Specific folder only
find ./4-The-Plan -name "*.md" | xargs grep -n "^##\? " 2>/dev/null

# Exclude archives
find . -name "*.md" -type f -not -path "*/archive/*" -not -path "*/z-*" | xargs grep -n "^##\? " 2>/dev/null | head -100

# Topic-specific (pipe to grep)
find . -name "*.md" | xargs grep -n "^##\? " 2>/dev/null | grep -i "security\|auth"

Pattern Reference

Token Efficiency

All commands return summaries, not full files. A complete doc index typically uses <200 tokens while giving you the map to know what to read next.

Related Skills

• startup: Full session bootstrap
• codebase-index: Code architecture discovery
• search-history: Conversation context