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

Check out the road map of DocFX here.

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

• Option 1: install DocFX through chocolatey package: choco install docfx -y.
• Option 2: install DocFX through nuget package: nuget install docfx.console, docfx.exe is under folder docfx.console/tools/.
• Option 3: play DocFX inside Visual Studio: create a Class Library (.NET Framework) project, 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.

For new comers, you can start with issues with 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.

DocFX is licensed under the MIT license.

DocFX is supported by the .NET Foundation.

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

1. Visual Studio 2017, minimum installation is enough.
2. Node.js, for building templates.

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

master	dev

Chocolatey	Nuget	Nightly Build

Windows with .NET Core v2.0.3	Windows with VS2017	Ubuntu Linux with Mono