Asciidoctor vs DocFX
Asciidoctor
asciidoctor.orgDocFX
dotnet.github.ioSide by side
| Figure | Asciidoctor | DocFX |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| Web | Yes | — |
| Windows | Yes | Yes |
| macOS | Yes | Yes |
| Linux | Yes | Yes |
| API | Yes | Yes |
| Self-hosted | Yes | Yes |
| Plans published | 1 | 1 |
| Spec score · Documentation Generators | 8.9 (#1) | 8.2 (#6) |
| Purpose | Asciidoctor parses AsciiDoc source and converts it into publishable formats such as HTML 5 and PDF. | DocFX builds technical documentation sites from .NET assemblies, XML code comments, REST API Swagger files, and Markdown. |
| Support | The documentation directs users seeking real-time community support to the project chat’s #users stream. | The DocFX project is listed as supported by the .NET Foundation. |
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.
DocFX
DocFX is a free static site generator for technical documentation. It builds documentation from .NET assemblies, XML code comments, REST API Swagger files and Markdown, and can produce rendered HTML pages, JSON models or PDFs. Static HTML output is placed in the `_site` folder for publication to hosting services such as GitHub Pages. DocFX can also be used as a NuGet library through the `Docfx.App` package and .NET APIs. It parses CommonMark-compliant Markdown with Markdig and supports additional extensions. Built-in templates include a modern option with dark mode and customization settings; users can also customize templates with CSS, JavaScript, Mustache templates and metadata. DocFX can generate git links for GitHub, GitLab, Azure Pipelines, AppVeyor, TeamCity and Jenkins. It requires .NET SDK 8.0 or higher. Node.js v20 or higher is optional generally, but required to create PDFs. Native reference documentation generation covers .NET and REST APIs; other languages need a custom API docs converter. PlantUML diagrams use a remote server by default, with local rendering available as a setting.