generate-props-documentation

Name: generate-props-documentation
Availability: InStock
Author: ntaksh42

Parse Astro component Props definitions and generate Markdown documentation.

Updated Nov 8, 2025

Search Tags:#markdown #codegen #docs #astro #props #type

Ready to run

npx skills add https://github.com/ntaksh42/windows-design-astro-components --skill generate-props-documentation

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: generate-props-documentation
Source: https://github.com/ntaksh42/windows-design-astro-components/tree/main/.claude/skills/generate-props-docs
Command: npx skills add https://github.com/ntaksh42/windows-design-astro-components --skill generate-props-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintaining consistent Props documentation across many Astro components is tedious. This Skill analyzes source definitions and auto-generates a unified Markdown Props reference.

Core Features & Use Cases

Component discovery: scans src/components/ui for Astro components
Props extraction: captures name, type, default, required, and description from TS interfaces and JSDoc
Markdown generation: per-component sections with a Props table
Output management: saves to docs/PROPS_REFERENCE.md with stats

Quick Start

Run the skill to generate the Props reference for all components; default output path is docs/PROPS_REFERENCE.md (will overwrite existing file after confirmation).

Frequently Asked Questions about generate-props-documentation

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

FAQPage Schema

How do I auto-generate Props documentation for Astro components?▼

Auto-generate Props documentation by running this Skill to scan your Astro components, extract prop definitions from TypeScript interfaces and JSDoc comments, and output a unified Markdown reference to docs/PROPS_REFERENCE.md with per-component Props tables and usage examples.

Can I automatically extract TypeScript prop types and descriptions from my Astro components?▼

Yes. This Skill parses TypeScript interfaces and JSDoc annotations across all components in src/components/ui, extracting prop names, types, default values, required flags, and descriptions to generate a comprehensive Props reference automatically.

What information does the generated Props documentation include?▼

The generated Markdown documentation includes per-component sections with a Props table containing prop names, TypeScript types, default values, required status, and JSDoc descriptions, plus generation statistics and an optional JSON export.

How do I maintain consistent Props documentation across multiple components?▼

This Skill automates consistency by parsing all Astro components in your repository, applying uniform extraction rules to prop definitions and descriptions, then generating a single unified Markdown Props reference that covers every component.

Does this work with existing JSDoc comments in my component code?▼

Yes. The Skill extracts JSDoc descriptions directly from your component source files and incorporates them into the generated Props table, preserving your existing documentation inline with the code.

What happens if Props extraction fails on some components?▼

The Skill includes error handling for extraction failures, allowing it to skip problematic components and continue processing others while reporting which components encountered issues.