CMinx vs TypeDoc
CMinx
cmakepp.github.ioTypeDoc
typedoc.orgSide by side
| Figure | CMinx | TypeDoc |
|---|---|---|
| Price from | — | Free |
| Free plan | — | Yes |
| Free trial | — | — |
| Open source | — | — |
| Linux | — | Yes |
| API | — | Yes |
| Self-hosted | — | Yes |
| Plans published | 0 | 1 |
| Spec score · Documentation Generators | 6.8 (#31) | 8.0 (#10) |
| Installation | The documentation recommends installing with pip, or building and installing through CMake. | TypeDoc runs on Node.js and is available as an npm package. |
| License | The GitHub repository identifies the project license as Apache-2.0. | The TypeDoc repository identifies its license as Apache-2.0. |
| Output formats | CMinx generates reStructuredText files whose contents can use reStructuredText markup. | The default output is HTML, and TypeDoc can also write a JSON model describing the project. |
| Purpose | CMinx generates API documentation for CMake functions and macros. | TypeDoc converts comments in TypeScript source code into HTML documentation or a JSON model. |
| Support | The project asks users to open an issue for questions, suggestions, or bug reports and says it will address them as soon as possible. | 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.