D

DocFX

Listed

Documentation generation tool for .NET projects that uses AI-like features to produce API documentation and conceptual articles from source code.

About

Documentation generation tool for .NET projects that uses AI-like features to produce API documentation and conceptual articles from source code.

Detailed overview

DocFX is a static site generator that builds technical documentation websites. It converts .NET assembly files, XML code comments, REST API Swagger files, and markdown into rendered HTML pages, JSON models, or PDF files. The product is intended for developers and technical writers who need to generate documentation from source code and related materials. Its key capabilities include creating a new documentation project via a command-line tool, building the site locally, and serving it for preview on a local web server. DocFX produces static HTML files in a `_site` folder, which can be published to any static site hosting server, including GitHub Pages, using a provided GitHub Actions workflow example. The tool requires .NET SDK 8.0 or higher, with Node.js v20 or higher optional for PDF generation. Users install DocFX globally via the .NET tool command, initialize a new project with `docfx init`, and build with `docfx docfx.json`. Prerequisites include command-line familiarity and the appropriate SDK installations.

Website link is available on the Verified plan