Every premium and members-only resource for $9.99/month, as a no-commitment subscription. See the plans

PalateKit

Sign in
Menu

Request a resource

Describe the resource you are missing in one sentence. We will email you when it is published.

0 / 280

A page, a video or an image online.

Unlock PalateKit

Unlock everything

Plan

Paying means accepting our terms of sale.

Secure payment by Stripe. Receipts and invoices sent by email.

Welcome back

Sign in to install, download or save this resource. A free account is enough for free resources.

Document a TypeScript API with TSDoc v1.0.0

Use this resource to document the public API of a TypeScript project

New

  • 411 downloads
  • 134 likes
  • 123 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install typescript-api-docs-tsdoc

With no option, the skill goes to ~/.agents/skills/; add --agent claude-code (or codex, cursor…) to target an agent.

First time: connect the CLI with

npx --yes palatekit@latest login

The agent adds TSDoc comments to functions and interfaces, uses the right tags and prepares documentation generation with TypeDoc or API Extractor. You get API docs readable in the editor and on the generated site.

Mostly picked by

Updated November 2, 2026

Card for the “Document a TypeScript API with TSDoc” skill

Details

Works in
Install guides
Generates with
Your agent's model
Licence
MIT

Similar resources

View all

What you get

  • SKILL.md: TSDoc syntax, block and modifier tags, documentation of functions and interfaces
  • advanced.md: JSDoc types in JavaScript, TypeDoc and API Extractor configuration, ESLint plugin

Good fit for

  • Your TypeScript library is used by other teams
  • You want a documentation page generated from the code

Not for

    Tags

    • tsdoc
    • typescript
    • documentation
    • api

    About

    You say

    “Document the public functions of this TypeScript module with @param, @returns and a usage example.”

    Card for the “Document a TypeScript API with TSDoc” skill

    Skill published by claude-dev-suite under the MIT license, delivered in its original version.

    Show more

    How to use it

    1. Install the skill in your agent's skills folder
    2. Ask your agent to document the public API of a TypeScript project
    3. Review and adjust the result

    Content preview

    Files

    • advanced.md4.5 KB
    • LICENSE1.1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md5.1 KB

    Origin and licence

    Listed unmodified

    Author
    claude-dev-suite
    Source
    github.com/claude-dev-suite/claude-dev-suite/tree/e10ab644ba43abe2abc923399226df4af7337214/skills/documentation/jsdoc-tsdoc
    Licence
    MIT

    Notice

    « jsdoc-tsdoc » (claude-dev-suite, MIT) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    User reviews

    –

    No ratings yet

    Loading reviews…

    Delete your review?

    Your rating and comment will be removed from the page.