JSDoc vs TypeDoc
JSDoc
jsdoc.appTypeDoc
typedoc.orgSide by side
| Figure | JSDoc | TypeDoc |
|---|---|---|
| Price from | — | Free |
| Free plan | — | Yes |
| Free trial | — | — |
| Open source | — | — |
| Linux | — | Yes |
| API | Yes | Yes |
| Self-hosted | Yes | Yes |
| Plans published | 0 | 1 |
| Spec score · Documentation Generators | 7.2 (#27) | 8.0 (#10) |
| Spec score · API Documentation Tools | 7.3 (#21) | 8.0 (#14) |
| Spec score · Api Docs | 7.2 (#16) | 8.0 (#11) |
| Configuration | Configuration files can use JSON or, in supported versions, a CommonJS module exporting a configuration object. | Options can be set through command-line arguments or configuration files. |
| Customization | Users can edit the default template or create a new template for generated documentation. | Themes can change the look and feel of generated documentation, and plugins can add themes. |
| Installation | The project README says JSDoc supports stable Node.js versions 8.15.0 and later and can be installed globally or in a project’s `node_modules` folder. | TypeDoc runs on Node.js and is available as an npm package. |
| Integrations | The project README lists community templates, Grunt and Gulp plugins, a GitHub Action, and a GitBook integration. | The GitHub Pages option generates a .nojekyll file, and source links can use GitHub or Bitbucket remotes. |
| License | The JSDoc generator is free software licensed under Apache License 2.0. | The TypeDoc repository identifies its license as Apache-2.0. |
| Purpose | JSDoc is an API documentation generator for JavaScript that scans source code comments and generates an HTML documentation website. | TypeDoc converts comments in TypeScript source code into HTML documentation or a JSON model. |
| Support | The project README directs users to the JSDoc Users mailing list and Stack Overflow questions tagged `jsdoc` for help. | The project README invites users to open an issue or pull request on GitHub and points contributors to its contribution guide. |
Plans
In their own words
TypeDoc
TypeDoc is a free TypeScript documentation generator that turns source comments into HTML pages or a JSON model. It builds from project exports and follows re-exports, allowing members declared elsewhere to appear in documentation. TSDoc and JSDoc tags are extracted, Markdown is accepted in comments, and fenced code blocks receive Shiki syntax highlighting. HTML and JSON are built in; Markdown output needs a plugin such as typedoc-plugin-markdown. A default theme is included, while plugins can add themes, alter conversion and symbol organization, or change display. Custom CSS and JavaScript can further adjust generated pages. Configuration can come from an options file, package.json, or tsconfig.json. TypeDoc runs on Node.js, uses the TypeScript compiler, and supports the current Node.js LTS or newer. For npm monorepos, the packages entry-point strategy can combine package documentation into one site. The project is Apache-2.0 licensed. Documentation warns that global installation can separate plugins and themes from the intended TypeDoc installation.