Skip to content
SPECIFICTION
Get listed

DocFX

dotnet.github.io

Free plan WindowsmacOSLinuxAPISelf-hosted
Visit dotnet.github.io
Spec score 8.2 #6 of 37 in Documentation Generators

What it 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 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.

Spec sheet

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

Plans and prices

DocFX Free Open-source static site generator; requires .NET SDK 8.0 or higher Read 2 Oct 2026 · dotnet.github.io

Every DocFX plan and price →

Strong points and limits

Strong points

  • Generates HTML, JSON models or PDF documentation.
  • Static output can be published to hosting services such as GitHub Pages.
  • Can be used as a NuGet library through Docfx.App.
  • Includes templates with dark mode and customization options.
  • Supports git links for several CI systems.

Limits

  • Requires .NET SDK 8.0 or higher.
  • PDF creation requires Node.js v20 or higher.
  • Other languages need a custom API docs converter.
  • PlantUML rendering uses a remote server by default.

Who it suits

DocFX suits teams building technical documentation sites from .NET, REST API and Markdown content. It also fits developers who want static HTML output or a .NET library for documentation generation.

Verdict

DocFX combines documentation generation, static-site output and library use, with built-in template and customization options. Check its .NET SDK requirement and the extra prerequisites or custom converter needs for your intended output.

Where Specifiction places it

Alternatives to DocFXAll alternatives →