Generate your API documentation with DocFX

What is it

DocFX makes it extremely easy to generate your developer hub with an API reference, a landing page, and how-tos.

What's next

Check out the road map of DocFX here.

NOTE: For more information on DocFX v3, please visit the v3 working branch.

How to use

• Option 1: install DocFX through the chocolatey package: choco install docfx -y.
• Option 2: install DocFX through the nuget package: nuget install docfx.console, docfx.exe is under folder docfx.console/tools/.
• Option 3: run DocFX inside Visual Studio: create a Class Library (.NET Framework) project, use Manage Nuget Packages to install docfx.console nuget package on the project, Build to create the generated website under folder _site.

For more information, please refer to Getting Started.

How to Contribute

For newcomers, you can start with issues labeled help-wanted. Check out the contributing page to see the best places to log issues and start discussions.

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

License

DocFX is licensed under the MIT license.

.NET Foundation

DocFX is supported by the .NET Foundation.

DocFX Project

dev is the default branch accepting Pull Requests. It releases a package daily. master branch is the release branch.

How to build from source code

Prerequisites

1. Visual Studio 2017 with the .NET Core cross-platform development toolset
2. Node.js

Steps

• Option 1: Run build.cmd under DocFX code repo.
• Option 2: Open docfx.sln under DocFX code repo in Visual Studio and build docfx.sln.

Build Status

master	dev

Packages

Chocolatey	Nuget	Nightly Build

Running Status

Windows with VS2017	Ubuntu Linux with Mono