DocFX
What it is
DocFX is a free static site generator for technical documentation. It builds from .NET assemblies, XML code comments, REST API Swagger files, and Markdown, and can produce rendered HTML, JSON models, or PDF files. Its static HTML output goes into the `_site` folder for publishing 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 templates can be customized with CSS, JavaScript, Mustache templates, and metadata settings. 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 overall but required for PDF creation. Native reference documentation generation covers .NET and REST APIs; other languages need a custom API docs converter.
For and against
For
- Builds documentation from assemblies, comments, Swagger files, and Markdown.
- Produces HTML, JSON models, or PDF files.
- Includes templates with dark mode and customization options.
- Can be used through the Docfx.App NuGet package.
Against
- Requires .NET SDK 8.0 or higher.
- PDF creation requires Node.js v20 or higher.
- Other languages need a custom API docs converter.
The verdict
DocFX supports a range of documentation inputs and output formats, with options for static hosting and template customization. Native reference documentation generation is limited to .NET and REST APIs.
Who it suits
DocFX suits developers and teams building technical documentation sites from .NET, REST API, and Markdown material. It also suits projects that need static HTML output or a NuGet library for documentation generation.
Plans and prices
DocFX
Open-source static site generator; requires .NET SDK 8.0 or higher
Read 2 Oct 2026 · dotnet.github.io
On the record
- API documentation
- DocFX generates .NET API documentation by converting XML documentation comments into rendered HTML documentation.dotnet.github.io · read 2 Oct 2026
- CI integrations
- DocFX can generate git links for GitHub, GitLab, Azure Pipelines, AppVeyor, TeamCity, and Jenkins.dotnet.github.io · read 2 Oct 2026
- Customization
- Users can customize templates with CSS, JavaScript, Mustache templates, and metadata settings.dotnet.github.io · read 2 Oct 2026
- Diagram rendering
- PlantUML diagrams render on a remote server by default, with local rendering available as a configurable option.dotnet.github.io · read 2 Oct 2026
- Language support limit
- DocFX natively generates reference documentation for .NET and REST APIs; other languages require a custom API docs converter.dotnet.github.io · read 2 Oct 2026
- Library use
- DocFX can also be used as a NuGet library through the `Docfx.App` package and its .NET APIs.dotnet.github.io · read 2 Oct 2026
- Markdown
- DocFX parses CommonMark-compliant Markdown with Markdig and supports additional Markdown extensions.dotnet.github.io · read 2 Oct 2026
- Output
- DocFX can produce rendered HTML pages, JSON models, or PDF files.dotnet.github.io · read 2 Oct 2026
- PDF prerequisite
- Node.js v20 or higher is an optional prerequisite, but is required when using the PDF creation feature.dotnet.github.io · read 2 Oct 2026
- Purpose
- DocFX builds technical documentation sites from .NET assemblies, XML code comments, REST API Swagger files, and Markdown.dotnet.github.io · read 2 Oct 2026
- Static hosting
- DocFX outputs static HTML in the `_site` folder for publishing to static site hosting services such as GitHub Pages.dotnet.github.io · read 2 Oct 2026
- Support
- The DocFX project is listed as supported by the .NET Foundation.dotnet.github.io · read 2 Oct 2026
- Templates
- DocFX includes built-in templates, and its modern template supports dark mode and customization options.dotnet.github.io · read 2 Oct 2026
