Skip to the content
Know your tech before you buy it. Makers: get listed from $49/mo

DocFX

dotnet.github.io

  • Free plan
  • Windows
  • macOS
  • Linux
  • API
  • Self-hosted
7.5 Club score Visit dotnet.github.io

What DocFX is

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 HTML pages, JSON models, or PDF files. Its static HTML output goes into 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 extra Markdown extensions. Built-in templates include a modern option with dark mode; users can also customize templates 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 required for PDF creation. Native reference documentation generation covers .NET and REST APIs; other languages need a custom API docs converter.

Who it suits

DocFX suits developers and teams creating technical documentation for .NET and REST APIs. Teams documenting other languages need a custom API docs converter.

Good to know, and what to watch

  • Generates HTML, JSON models, and PDF files.
  • Can be used as a NuGet library.
  • Built-in modern template supports dark mode.
  • Supports git links for several CI systems.
  • Requires .NET SDK 8.0 or higher.
  • PDF creation requires Node.js v20 or higher.
  • Other languages need a custom API docs converter.

DocFX

Free

Free plan

The verdict

DocFX offers a free route from code comments, Swagger files, and Markdown to documentation outputs. Its native reference documentation support focuses on .NET and REST APIs.

What the maker publishes

API documentation
DocFX generates .NET API documentation by converting XML documentation comments into rendered HTML documentation. source
CI integrations
DocFX can generate git links for GitHub, GitLab, Azure Pipelines, AppVeyor, TeamCity, and Jenkins. source
Customization
Users can customize templates with CSS, JavaScript, Mustache templates, and metadata settings. source
Diagram rendering
PlantUML diagrams render on a remote server by default, with local rendering available as a configurable option. source
Free plan
Yes source
Language support limit
DocFX natively generates reference documentation for .NET and REST APIs; other languages require a custom API docs converter. source
Library use
DocFX can also be used as a NuGet library through the `Docfx.App` package and its .NET APIs. source
Markdown
DocFX parses CommonMark-compliant Markdown with Markdig and supports additional Markdown extensions. source
Output
DocFX can produce rendered HTML pages, JSON models, or PDF files. source
PDF prerequisite
Node.js v20 or higher is an optional prerequisite, but is required when using the PDF creation feature. source
Purpose
DocFX builds technical documentation sites from .NET assemblies, XML code comments, REST API Swagger files, and Markdown. source
Static hosting
DocFX outputs static HTML in the `_site` folder for publishing to static site hosting services such as GitHub Pages. source
Support
The DocFX project is listed as supported by the .NET Foundation. source
Templates
DocFX includes built-in templates, and its modern template supports dark mode and customization options. source

Checked against the maker's pages on 2 Oct 2026.