user-docs-build-toc

Generate a markdown table of contents from documentation file headers.

Updated Mar 24, 2026
One-click install
npx skills add https://github.com/spencerbeggs/design-docs-plugin --skill user-docs-build-toc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: user-docs-build-toc
Source: https://github.com/spencerbeggs/design-docs-plugin/tree/main/plugin/skills/user-docs-build-toc
Command: npx skills add https://github.com/spencerbeggs/design-docs-plugin --skill user-docs-build-toc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill eliminates the manual effort of maintaining a table of contents for documentation folders, ensuring that your README files stay perfectly synced with your content as you add or rename pages.

Core Features & Use Cases

  • Automated Indexing: Scans documentation directories to generate a clean, bulleted list of links based on file headers.
  • Smart Customization: Preserves manual descriptions in existing READMEs while updating the structure and link order.
  • Use Case: When you add a new guide to your docs folder, this skill automatically updates your main documentation index with the correct title and a summary of the new page content.

Quick Start

Run the user-docs-build-toc skill to generate a table of contents for the current documentation directory.

Frequently Asked Questions about user-docs-build-toc

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

FAQPage Schema
How do I automatically generate a table of contents for markdown documentation?

To automatically generate a table of contents for markdown documentation, you need a tool that scans your directory, parses file headers, and extracts H1 titles to create a structured, navigable link list.

Can I update a documentation index without losing my existing manual descriptions?

Yes, automated documentation TOC generation can preserve manual descriptions in existing README files while updating the structure and link order to stay synced with your content.

What is the best way to keep a README table of contents synced with my docs folder?

The best way to keep a README table of contents synced with your docs folder is automating TOC generation to scan directories and extract introductory text whenever you add or rename pages.

Does automated markdown TOC generation require file system read access?

Yes, generating a structured markdown table of contents requires file system read access to parse markdown files, extract H1 titles, and process introductory paragraph content.

How does a documentation TOC generator extract page summaries?

A documentation TOC generator extracts page summaries by processing file headers and introductory paragraph content from markdown files to create consistent, navigable link lists for project documentation.