---
name: "typedoc-typescript-api-extractor"
description: "Extract comprehensive HTML and Markdown API documentation from TypeScript codebases."
metadata:
  author: "TypeDoc"
  version: "1.0.0"
  runtime_compatibility:
    - "codex"
    - "claude-code"
    - "cursor"
    - "windsurf"
triggers:
  - "generate typescript docs typedoc"
  - "use typedoc-plugin-markdown"
  - "document typescript interfaces"
permissions:
  fs_read: true
  fs_write: "workspace"
  shell_exec: false
  net_access: false
---

# TypeDoc TypeScript API Documentation

Parses TypeScript source files and JSDoc / TSDoc comments with TypeDoc: class inheritance diagrams, interface property tables, function overloads, and typedoc-plugin-markdown output.

## When to Invoke
Invoke this skill whenever you need to:
- generate typescript docs typedoc
- use typedoc-plugin-markdown
- document typescript interfaces

## Execution SOP & Rules
1. Configure settings in typedoc.json with entryPoints: ["src/index.ts"].
2. Document public APIs with TSDoc tags (@param, @returns, @remarks, @typeParam).
3. Generate markdown files for wikis using typedoc --plugin typedoc-plugin-markdown.
4. Set excludePrivate: true and excludeInternal: true to hide non-public internal implementation.

## Verification Checklist
- Run local linting, syntax validation, and type-checks before reporting completion.
- Ensure all created or modified files adhere to workspace boundaries and avoid uncommitted secrets.
- Verify tests or build commands exit cleanly with return code 0.