Docs

typescript-api-doc-generator

by tinh2

Autonomously generates comprehensive, accurate API documentation from TypeScript source code, including endpoints, request/response schemas, inline comments, and security considerations, following industry best practices for clarity, structure, and safety.

v1.0.0New

Signing

SignedSLSA L2
Signed by
skills-hub.ai distributor
Method
Distributor-signed by skills-hub.aiCryptographically signed by the skills-hub.ai distributor key at publish time.
Signed

Install this skill

Run this command in your terminal. No account required — it auto-detects your AI tool and installs the skill file.

npx @skills-hub-ai/cli install typescript-api-doc-generator
Or download directly:
Browse all CLI commands →

Setup by platform

Claude Code

~/.claude/skills/<skill>/SKILL.md

Setup guide →

Cursor

~/.cursor/skills/<skill>/SKILL.md

Setup guide →

Install

One-click setup for your editor

Run in your project root

npx @skills-hub-ai/cli install typescript-api-doc-generator --target claude-code
0

Instructions

This skill doesn’t include stateful context yet, instructions only. Learn about stateful skills.

Security

Loading security scan...

Reviews (0)

View full changelog & diffs →

Related skills

Browse all →
perplexity-searchAI-powered web search and research using the Perplexity API (Sonar models). Performs deep web research with citations, fact-checking, competitive analysis, market research, and technical documentation lookup. Supports streaming responses, search domain filtering, and recency filtering.5 installsapi-to-typemcpUse when a user wants to turn an API URL, OpenAPI/Swagger file or link, Swagger UI, or Markdown/HTML API documentation into a standalone TypeMCP MCP project through the type-mcp-api-cli.0 installswp-deployDeploy content to WordPress via REST API — handles auth, media upload, and post/page creation0 installsokfileUpload and publish images, videos, PDFs, and common files to OkFile, or publish a static site folder to a per-site subdomain with directory listing fallback when root index.html is absent. Official site: https://www.okfile.com/0 installs

More Docs skills

Browse category →
blog-writerWrite human-sounding, SEO-optimized blog posts for skills-hub.ai. Use when: 'write a blog post', 'draft a post', 'update blog', 'blog about', 'write about'. Supports styles: tutorial, deep_dive, opinion, listicle, case_study.6 installsapi-docsGenerate OpenAPI 3.1 documentation from your API codebase. Auto-detects Express, Fastify, NestJS, Django, FastAPI, Flask, Rails, Spring, Go, and more. Extracts routes, request/response schemas, auth requirements, and validation rules. Sets up interactive docs with Swagger UI, Redoc, or Scalar. Use when you need API documentation, OpenAPI spec, Swagger docs, endpoint reference, or REST API docs.4 installsreadmeGenerate project documentation — README files, API docs, and changelogs. Triggers: README, documentation, generate docs, document this project, write README, API docs, changelog.4 installsadrCreate and manage Architecture Decision Records using the Michael Nygard format. Supports new ADR creation, retrospective analysis to document existing decisions, superseding, deprecating, and index generation. Use when you need to document architecture decisions, record technical choices, explain why a technology was chosen, or create decision logs.4 installsdiagramGenerate Mermaid architecture diagrams from your codebase. Produces C4 context and container diagrams, sequence diagrams for key flows, ER diagrams from database schemas, and module dependency graphs. Use when you need architecture diagrams, system diagrams, database ERD, sequence diagrams, dependency visualization, or C4 model diagrams.3 installsrunbookGenerate an operations runbook from your deployment config, Docker/K8s manifests, CI/CD pipelines, and monitoring setup. Produces copy-pasteable procedures for deployment, rollback, scaling, database maintenance, incident response, and troubleshooting. Use when you need a runbook, ops playbook, deployment guide, incident response plan, or production operations documentation.2 installs

Frequently asked questions about typescript-api-doc-generator

What does the typescript-api-doc-generator skill do?

Autonomously generates comprehensive, accurate API documentation from TypeScript source code, including endpoints, request/response schemas, inline comments, and security considerations, following industry best practices for clarity, structure, and safety. It's a reusable SKILL.md instruction set that loads into your AI coding assistant on demand, no prompt engineering, no copy-pasting every session.

How do I install the typescript-api-doc-generator skill?

Run `npx @skills-hub-ai/cli install typescript-api-doc-generator` from your terminal. The CLI writes the SKILL.md to the correct location for your AI tool (e.g. ~/.claude/skills/typescript-api-doc-generator/ for Claude Code or ~/.cursor/skills/ for Cursor with --target cursor) and adds it to your project's .skills.json lockfile.

Which AI tools does typescript-api-doc-generator work with?

typescript-api-doc-generator runs in Claude Code, Cursor. It follows the open Agent Skills standard (SKILL.md), so the same skill works in every supported tool without modification.

Is the typescript-api-doc-generator skill free?

Yes. Every skill on skills-hub.ai is free and open-source. There are no premium tiers, paywalls, or usage limits. You only pay for whatever AI assistant you're already using.

How do I use typescript-api-doc-generator after installing it?

In Claude Code, type `/typescript-api-doc-generator` (or whatever slash command the skill registers) and the AI follows the skill's instructions immediately. You can also reference it by name in natural language, your AI loads the skill into context when relevant.

Can I share the typescript-api-doc-generator skill with my team?

Yes. Commit your project's .skills.json lockfile and teammates run `npx @skills-hub-ai/cli install` (no args) to install every skill at the exact version you pinned. Organization-scoped installs work via skills-hub.ai organizations.