Asciidoctor
6.9#4 in documentation generatorsFree planFree planWebAPIExtensionLinux
VisitAsciidoctor vs TypeDoc
What both publish
| Fact | Asciidoctor | TypeDoc |
|---|---|---|
| Integrations | The project ecosystem includes Maven and Gradle plugins, browser extensions, an IntelliJ plugin, and tools such as Asciidoctor Diagram. | The GitHub Pages option generates a .nojekyll file, and source links can use GitHub or Bitbucket remotes. |
| License | The processor is open source software available under the MIT license. | The TypeDoc repository identifies its license as Apache-2.0. |
| Output formats | The core processor includes HTML 5, DocBook 5 and man page converters; PDF and EPUB 3 converters are provided separately. | HTML and JSON are built-in output types; Markdown output requires a plugin such as typedoc-plugin-markdown. |
| Purpose | Asciidoctor parses AsciiDoc source and converts it into publishable formats such as HTML 5 and PDF. | TypeDoc converts comments in TypeScript source code into HTML documentation or a JSON model. |
| Support | The documentation directs users seeking real-time community support to the project chat’s #users stream. | The project README invites users to open an issue or pull request on GitHub and points contributors to its contribution guide. |
Asciidoctor plans
- AsciidoctorFree
TypeDoc plans
- Free and open sourceFree
Pick Asciidoctor if…
Asciidoctor suits writers and developers publishing AsciiDoc across different formats and runtimes. Its command-line, API, and build-tool integrations also fit documentation workflows that use Ruby, Java, or JavaScript.
Pick TypeDoc if…
TypeDoc suits TypeScript developers who want to generate documentation from code comments and project exports. Its plugins and monorepo support may also suit projects that need customized output or combined package documentation.