◆codeseed
Sign in
Explore Projects
TypeScriptbeginnercliAI Generated

API Documentation Generator

CLI tool that parses JSDoc/TSDoc comments from TypeScript code and generates HTML or Markdown documentation.

5 steps
Sign in to claim this project
Project Roadmap
  1. 01

    CLI commander

    Command: gen-docs --input src/ --output docs/ --format html|md

  2. 02

    TypeDoc parsing

    Programmatically use TypeDoc to extract symbols and their comments.

  3. 03

    HTML Template

    Handlebars template with navigable sidebar, search, and syntax highlighting.

  4. 04

    Markdown output

    Alternatively, generate .md files per module for documentation on GitHub.

  5. 05

    Watch mode

    Flag --watch re-generates documentation on source file changes.

Resources

Ready to build this?

Fork the repo on GitHub and start building. A mentor will review your code when you open a PR.

5 steps

Tech Stack

TypeScriptTypeDoccommandermarkedhighlight.js