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, producing rendered HTML pages, JSON models or PDF files. Static HTML is written to the `_site` folder for publishing to 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 Markdown extensions. Built-in templates include a modern option with dark mode; customization can use CSS, JavaScript, Mustache templates and metadata settings. DocFX can generate git links for GitHub, GitLab, Azure Pipelines, AppVeyor, TeamCity and Jenkins. Native reference-documentation generation covers .NET and REST APIs; other languages require a custom API docs converter. The project requires .NET SDK 8.0 or higher. Node.js v20 or higher is optional except when creating PDFs, which requires it. PlantUML diagrams render on a remote server by default, with local rendering available as a configuration option. The project is listed as supported by the .NET Foundation.
Who it is for
DocFX suits developers building technical documentation sites from .NET, REST API and Markdown material. It may also suit teams that want static HTML output, PDF generation or integration with listed CI systems.
What is good
- Free and open-source static site generator.
- Produces HTML, JSON models and PDF files.
- Supports customizable templates and dark mode.
- Can generate git links for several CI systems.
- Can be used as a NuGet library.
What to know first
- Requires .NET SDK 8.0 or higher.
- PDF creation requires Node.js v20 or higher.
- Other language references require a custom API docs converter.
- PlantUML rendering uses a remote server by default.
Verdict
DocFX covers documentation generation from .NET, REST API and Markdown inputs, with static output and template customization. Check its .NET requirement and the additional PDF prerequisite, and plan for a custom converter if documenting other languages.
DocFX plans and pricing
All plansCompared on knowledge base software
- Free plan
- Yes
- Documentation analytics
- Yes
