jsdoc-tsdoc

Solid

JavaScript and TypeScript documentation generation using JSDoc and TSDoc. Parse source code, generate API documentation, validate coverage, and integrate with TypeDoc for comprehensive developer documentation.

AI & Automation 1,160 stars 71 forks Updated today MIT

Install

View on GitHub

Quality Score: 99/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# JSDoc/TSDoc Skill Generate and validate JavaScript and TypeScript documentation using industry-standard JSDoc and TSDoc conventions with TypeDoc integration. ## Capabilities - Parse JSDoc comments from JavaScript source code - Parse TSDoc comments from TypeScript source code - Generate API documentation with TypeDoc - Validate documentation coverage and completeness - Enforce documentation standards with ESLint plugins - Support custom JSDoc/TSDoc tags - Type inference and documentation alignment - Generate multiple output formats (HTML, Markdown, JSON) ## Usage Invoke this skill when you need to: - Document JavaScript/TypeScript libraries and APIs - Generate API reference documentation - Audit documentation coverage - Set up automated documentation pipelines - Validate doc comments match implementation ## Inputs | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | projectPath | string | Yes | Root path of the JS/TS project | | entryPoints | array | No | Specific files/directories to document | | outputDir | string | No | Documentation output directory (default: docs) | | outputFormat | string | No | html, markdown, json (default: html) | | includePrivate | boolean | No | Include private members (default: false) | | coverageThreshold | number | No | Minimum documentation coverage % | | customTags | array | No | Additional JSDoc/TSDoc tags to recognize | ### Input Example ```json { "projectPath": "./packages/sdk", "entryP...

Details

Author
a5c-ai
Repository
a5c-ai/babysitter
Created
4 months ago
Last Updated
today
Language
JavaScript
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Solid

typescript-docs

Generates comprehensive TypeScript documentation using JSDoc, TypeDoc, and multi-layered documentation patterns for different audiences. Use when creating API documentation, architectural decision records (ADRs), code examples, and framework-specific patterns for NestJS, Express, React, Angular, and Vue.

263 Updated 1 weeks ago
giuseppe-trisciuoglio
AI & Automation Solid

doxygen-javadoc

Documentation generation for C, C++, and Java codebases using Doxygen and Javadoc. Extract API documentation from source code, generate cross-references, call graphs, and comprehensive technical documentation.

1,160 Updated today
a5c-ai
Code & Development Listed

typescript-jsdoc

Write effective JSDoc comments for TypeScript code. Provides guidance on documentation format, strategic placement, best practices, and when to document versus when to keep code self-documenting. Helps maintain code clarity and IDE support.

335 Updated today
aiskillstore
Data & Documents Listed

writing-docs

Expert at writing high-quality documentation for code, APIs, and projects. Auto-invokes when generating docstrings, creating README files, writing API documentation, adding code comments, or producing any technical documentation. Provides language-specific templates and best practices for effective documentation writing.

335 Updated today
aiskillstore
Data & Documents Solid

when-documenting-code-use-doc-generator

Automated comprehensive code documentation generation with API docs, README files, inline comments, and architecture diagrams

335 Updated today
aiskillstore