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.exeis 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.consolenuget 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.
Apart from dev branch, stable branch builds daily, and master branch is the release branch.
- Visual Studio 2017, minimum installation is enough.
- Node.js, for building templates.
- Option 1: Run
build.cmdunder DocFX code repo. - Option 2: Open
All.slnunder DocFX code repo in Visual Studio and build All.sln.
| Build Status | Package | Chocolatey | |
|---|---|---|---|
| master |  |
 |
|
| stable |  |
- Running Status
| Running Status | Windows with .NET Core v2.0.3 | Windows with VS2017 | Ubuntu Linux with Mono |
|---|---|---|---|
|
 |