Build technical documentation sites with Docfx

Quickly build static documentation sites using markdown files. Generate .NET API reference pages directly from assemblies.

Get Started Install

Installation

Install docfx as a dotnet tool on Windows, Mac or Linux.

dotnet tool install docfx

Create a new website and add a new markdown article:

mkdir my-docs
cd my-docs
docfx new conceptual
echo "Hello World" > hello.md

Edit and preview content changes locally. Open a browser and go to https://localhost:8080 after executing this command:

docfx build
docfx serve

Create a git repository. Add, commit and push your website to GitHub Pages

cd _site
git init
git add --all
git commit -m "Initial commit"
git push -u https://github.com/username/username.github.io main

Create, collabrate and manage documentations as code, using simple text formats like markdown and YAML.

Works seamlessly with your favorite text editors and source control systems.

Automatically generates .NET API reference documentation from DLLs and standard XML documentation files.

Produces static HTML files ready to publish to GitHub Pages.