DocFX vs Docusaurus
DocFX
dotnet.github.ioDocusaurus
docusaurus.ioSide by side
| Figure | DocFX | Docusaurus |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| Web | — | Yes |
| Windows | Yes | — |
| macOS | Yes | — |
| Linux | Yes | — |
| API | Yes | — |
| Self-hosted | Yes | Yes |
| Plans published | 1 | 1 |
| Spec score · Technical Documentation Software | 8.2 (#12) | 8.1 (#15) |
| Spec score · Technical Writing Platforms | 8.3 (#9) | 8.1 (#14) |
| Spec score · Developer Documentation Software | 8.2 (#11) | 8.0 (#14) |
| Spec score · Knowledge base software | 7.7 (#102) | 7.7 (#101) |
| Customization | Users can customize templates with CSS, JavaScript, Mustache templates, and metadata settings. | Sites can be extended with React components, plugins, and theme customizations. |
| Free plan | Yes | Yes |
Plans
In their own words
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.
Docusaurus
Docusaurus is a free static-site generator that builds React single-page applications, with features aimed at documentation sites. Authors write documentation and blog posts in Markdown or MDX and can embed React components in Markdown. Versioning keeps documents aligned with project releases, while localization is built in and translation can use Git, Crowdin or another manager. Search choices include Algolia DocSearch, Typesense DocSearch, local search and custom SearchBar components; Algolia is the official option, and its DocSearch is free for eligible developer documentation or technical blogs. React components, plugins and theme customizations extend sites. Docusaurus generates static files for hosting on GitHub Pages, Vercel, Netlify or other static hosting. It can also power personal websites, product sites, blogs and marketing landing pages. Installation requires Node.js 20.0 or above. The listed platforms are self-hosted and web, with custom domains, version history and content analytics available. Docusaurus v2 and later do not support Internet Explorer 11. Help channels include Stack Overflow, GitHub, Discord and X.