Generate your API documentation with DocFX
- Build Status
- Running Status
|Running Status||Windows with .NET Core v2.0.3||Windows with VS2017||Ubuntu Linux with Mono||Mac with Mono|
Check out the road map of DocFX here.
NOTE: For more information on DocFX v3, please visit the v3 working branch.
Collecting feedbacks and proposals for DocFX
Let's make DocFX better together!
Vote for the proposals you like, and add yours:
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.
How do I play with DocFX?
- 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
For more information, please refer to Getting Started.
Integrate with Continuous Integration environment
Install DocFX through chocolatey package
choco install 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.
Contributors & Thank You
Many thanks go to our community of developers who helped improve the quality of DocFX through their code contributions. Contributors:
DocFX is licensed under the MIT license.
DocFX is supported by the .NET Foundation.