Asciidoctor vs YARD
Asciidoctor
asciidoctor.orgYARD
yardoc.orgSide by side
| Figure | Asciidoctor | YARD |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| Web | Yes | — |
| Windows | Yes | — |
| macOS | Yes | — |
| Linux | Yes | Yes |
| API | Yes | — |
| Self-hosted | Yes | — |
| Plans published | 1 | 1 |
| Spec score · Documentation Generators | 8.9 (#1) | 7.1 (#29) |
| Integrations | The project ecosystem includes Maven and Gradle plugins, browser extensions, an IntelliJ plugin, and tools such as Asciidoctor Diagram. | The site names plugins supporting RSpec, DataMapper, and Sinatra. |
| License | The processor is open source software available under the MIT license. | The site states that YARD uses the MIT License. |
| Purpose | Asciidoctor parses AsciiDoc source and converts it into publishable formats such as HTML 5 and PDF. | YARD generates consistent, usable documentation for the Ruby programming language and can export it to different formats. |
| Support | The documentation directs users seeking real-time community support to the project chat’s #users stream. | The site lists an IRC channel, a mailing list, and GitHub as ways to get in touch. |
Plans
In their own words
Asciidoctor
Asciidoctor is a free, open-source text processor and publishing toolchain for converting AsciiDoc files or strings into formats such as HTML5, DocBook, PDF, EPUB 3 and manual pages. Its core includes converters for HTML5, DocBook 5 and man pages; PDF and EPUB 3 conversion comes from separate gems. Documents can be processed through a command-line interface or Ruby API. Asciidoctor runs with Ruby, on the JVM through AsciidoctorJ, or in JavaScript environments through Asciidoctor.js, and supports Linux, macOS and Windows. The wider ecosystem includes Maven and Gradle plugins, browser and editor extensions, and diagram tools. Default HTML output includes a stylesheet and integrations such as Font Awesome, highlight.js, Rouge, Pygments and MathJax. It is distributed as a RubyGem, Docker image, Linux packages and macOS packages, and is licensed under MIT. Its security modes include SECURE, SAFE, SERVER and UNSAFE; safe modes do not sanitize generated output or provide a comprehensive security framework.