About DocFX
DocFX is a documentation generator for .NET projects and general technical documentation. It converts assemblies, code comments and Markdown pages into a rendered website.
What it does
DocFX converts .NET assemblies, XML code comments, REST API Swagger files and Markdown into rendered HTML pages. It can also produce a JSON model or PDF files. The site is built as static files under a _site folder, so it can be hosted on any static host, including GitHub Pages through a GitHub Actions workflow.
Key features
- Renders .NET API reference from code comments
- Markdown pages with a table of contents
- Reads REST API Swagger files
- Creates PDF files when Node.js is installed
- Local preview server for checking changes
Who it's for
.NET teams that want API reference alongside written guides. It also suits technical writers and platform teams who publish documentation from a repository and want the build to run in continuous integration.
Pricing and good to know
The repository is listed under the MIT license. It is installed as a .NET global tool and needs the .NET SDK 8.0 or higher. Creating PDF files also requires Node.js 20 or higher. You can start a new site with a single init command and preview it locally before publishing.
Highlights
- Renders .NET API reference from code comments
- Converts Markdown pages with a table of contents
- Reads REST API Swagger files
- Creates PDF output when Node.js is installed
- Previews the site locally with a serve command
