RAML2HTML vs TypeDoc
RAML2HTML
github.comTypeDoc
typedoc.orgSide by side
| Figure | RAML2HTML | TypeDoc |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| Linux | Yes | Yes |
| API | — | Yes |
| Self-hosted | Yes | Yes |
| Plans published | 1 | 1 |
| Spec score · Api Docs | 7.5 (#13) | 8.0 (#11) |
| Spec score · API Documentation Tools | 7.4 (#19) | 8.0 (#14) |
| Customization | The rendering configuration can provide custom processing, HTML post-processing, output writing, and Nunjucks setup functions. | Themes can change the look and feel of generated documentation, and plugins can add themes. |
| Installation | The README instructs users to install the package globally with npm. | TypeDoc runs on Node.js and is available as an npm package. |
| License | RAML2HTML is available under the MIT license. | The TypeDoc repository identifies its license as Apache-2.0. |
| Output formats | The README gives an example of using a theme to render RAML to Markdown. | The default output is HTML, and TypeDoc can also write a JSON model describing the project. |
| Purpose | RAML2HTML is a simple RAML-to-HTML documentation generator written for Node.js. | TypeDoc converts comments in TypeScript source code into HTML documentation or a JSON model. |
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.