What documentation formats are supported?

It supports JSDoc/TSDoc code comments, Markdown files for static documentation, and .stories.tsx files for Storybook.

Does it support TypeScript?

Yes, it is specifically designed to leverage TypeScript types for accurate TSDoc generation and Prop table creation.

Is this skill useful for non-React projects?

Absolutely. While it has specialized React features, its primary function is documenting any JavaScript/TypeScript function, class, or type.

Can it update existing documentation?

Yes, the skill is capable of merging updates into existing documentation or overwriting them based on your preference.

API Documenter

Name: API Documenter
Author: physics91

byphysics91

0•

Learning & Documentation

Generates comprehensive JSDoc/TSDoc comments, Markdown documentation, and Storybook stories for functions, classes, and components.

The API Documenter skill simplifies the documentation process by automatically generating industry-standard JSDoc/TSDoc comments, detailed React Prop tables, and standalone Markdown files. It bridges the gap between code and documentation by intelligently inferring types from TypeScript definitions and scaffolding Storybook stories for UI components. Designed for developers who value maintainability, this skill ensures that public APIs remain well-documented and consistent without the manual overhead typically associated with technical writing.

Key Features

01Comprehensive React Props documentation with default value detection

02Automated JSDoc and TSDoc comment generation for functions and classes

030 GitHub stars

04Automatic generation of Storybook story files with diverse state examples

05Standalone Markdown API documentation generation for external docs

06Intelligent type inference from TypeScript exports and interfaces

Use Cases

01Rapidly generating Storybook previews for newly created React components

02Standardizing documentation across large-scale TypeScript or JavaScript projects

03Automating the creation of external API reference guides from source code

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add physics91/claude-vibe api-documenter

For use in Claude.ai and ChatGPT

Download Skill