Generate your API documentation with DocFX
What is it?
DocFX makes it extremely easy to generate your developer hub with API reference, landing page, and how-to.
We currently support C# and VB projects.
How to build?
- Option 1: Run
build.cmdunder DocFX code repo.
- Option 2: Open
All.slnunder DocFX code repo in Visual Studio and build All.sln.
Possible build issues
- Test failure with message
\r\nnot equal to
\nfor Windows Set
git config --global core.autocrlf true
How do I play with DocFX?
Please refer to Getting Started.
Integrate with Continuous Integration environment
Install docfx through chocolatey package
cinst docfx -y
docfx-seed project provides a sample integrating with AppVeyor.
[!NOTE] Known issue in AppVeyor: Currently
platform: Any CPUin appveyor.yml causes
docfx metadatafailure. https://github.com/dotnet/docfx/issues/1078
|LICENSE||Project license information|
|README.md||Introduction to the project|
|CONTRIBUTING.md||Contribution guidelines to how to contribute to the repo|
|Documentation||Source for our documentation site|
|src||Source code for DocFX|
|test||Test cases for DocFX using xunit test framework|
|tools||Source code for tools used in code build and deployment|
How to Contribute
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.