DocFX

Summary

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. Its static HTML output goes into the `_site` folder, ready for publishing to static 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; templates can be customized with CSS, JavaScript, Mustache templates and metadata settings. DocFX can generate git links for services including GitHub, GitLab, Azure Pipelines, AppVeyor, TeamCity and Jenkins. The project requires .NET SDK 8.0 or higher. Node.js v20 or higher is optional except for PDF creation, which requires it. Native reference-documentation generation covers .NET and REST APIs; other languages require a custom API docs converter.

Who it is for

DocFX suits developers and teams building technical documentation sites from .NET, REST API and Markdown content. It may fit workflows that publish static HTML or use a NuGet library.

Compared on knowledge base software

Free plan

Yesdotnet.github.io

Documentation analytics

Yesdotnet.github.io

Facts

Purpose

DocFX builds technical documentation sites from .NET assemblies, XML code comments, REST API Swagger files, and Markdown.dotnet.github.io · 2 Oct 2026

Output

DocFX can produce rendered HTML pages, JSON models, or PDF files.dotnet.github.io · 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 · 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 · 2 Oct 2026

Markdown

DocFX parses CommonMark-compliant Markdown with Markdig and supports additional Markdown extensions.dotnet.github.io · 2 Oct 2026

Templates

DocFX includes built-in templates, and its modern template supports dark mode and customization options.dotnet.github.io · 2 Oct 2026

Customization

Users can customize templates with CSS, JavaScript, Mustache templates, and metadata settings.dotnet.github.io · 2 Oct 2026

CI integrations

DocFX can generate git links for GitHub, GitLab, Azure Pipelines, AppVeyor, TeamCity, and Jenkins.dotnet.github.io · 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 · 2 Oct 2026

API documentation

DocFX generates .NET API documentation by converting XML documentation comments into rendered HTML documentation.dotnet.github.io · 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 · 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 · 2 Oct 2026

Support

The DocFX project is listed as supported by the .NET Foundation.dotnet.github.io · 2 Oct 2026

Where it ranks on Everything Xiaomi

• Best Knowledge Base Software in 2026#63 of 138
• Best Documentation Generators in 2026#6 of 38
• Best Technical Documentation Software in 2026#5 of 35
• Best Developer Documentation Software in 2026#5 of 27

Sources

• dotnet.github.io/docfx/· checked 2 Oct 2026
• dotnet.github.io/docfx/docs/markdown.html· checked 2 Oct 2026
• dotnet.github.io/docfx/docs/template.html· checked 2 Oct 2026
• dotnet.github.io/docfx/docs/dotnet-api-docs.html· checked 2 Oct 2026
• dotnet.github.io/docfx/docs/additional-languages.html· checked 2 Oct 2026