API Documentation Generator

Project steps

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.