TypeDoc vs Widdershins
TypeDoc
typedoc.orgWiddershins
github.comSide by side
| Figure | TypeDoc | Widdershins |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| Linux | Yes | Yes |
| API | Yes | Yes |
| Self-hosted | Yes | Yes |
| Plans published | 1 | 1 |
| Spec score · Documentation Generators | 8.0 (#10) | 7.1 (#28) |
| Spec score · API Documentation Tools | 8.0 (#14) | 7.2 (#24) |
| Spec score · Api Docs | 8.0 (#11) | 7.2 (#17) |
| Integrations | The GitHub Pages option generates a .nojekyll file, and source links can use GitHub or Bitbucket remotes. | The README describes using Widdershins with Slate, ReSlate, Shins, and ReSpec renderers. |
| License | The TypeDoc repository identifies its license as Apache-2.0. | The repository identifies its license as MIT. |
| Output formats | The default output is HTML, and TypeDoc can also write a JSON model describing the project. | Widdershins can produce Markdown and can also output HTML directly or use ReSpec format. |
| Purpose | TypeDoc converts comments in TypeScript source code into HTML documentation or a JSON model. | Widdershins converts OpenAPI, Swagger, AsyncAPI, and Semoasa definitions into Markdown compatible with Slate and ReSlate. |
| Security | The GitHub repository links to a security policy, but the opened repository page does not state specific security certifications or compliance claims. | The README documents generated Authorization headers in OpenAPI code samples and provides an option to customize the API key value. |
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.
Widdershins
Widdershins has no write-up on Specifiction yet; its figures are above.