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. For more information on DocFX v3, please visit the v3 working branch.
choco install docfx
docfx init -q
docfx docfx_project\docfx.json --serve
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. main branch is the release branch.
- Visual Studio 2019 with .NET Core cross-platform development toolset
- Node.js
- Option 1: Run
build.cmdunder DocFX code repo. - Option 2: Open
docfx.slnunder DocFX code repo in Visual Studio and build docfx.sln.
| main | dev |
|---|---|
| Chocolatey | Nuget |
|---|---|
 |
 |
| Windows with VS2017 | Ubuntu Linux with Mono |
|---|---|
 |