Generate your API documentation with DocFX
Build Status | Package | Chocolatey | |
---|---|---|---|
master | |||
dev |
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?
Prerequisites
- Visual Studio 2017 with .NET Core cross-platform development toolset installed
- Node.js
Steps
- 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.
How do I play with DocFX?
Please refer to Getting Started.
Integrate with Continuous Integration environment
-
Install docfx through chocolatey package
cinst docfx -y
-
Call docfx
docfx docfx.json
docfx-seed project provides a sample integrating with AppVeyor.
NOTE: Known issue in AppVeyor: Currently
platform: Any CPU
in appveyor.yml causesdocfx metadata
failure. dotnet#1078
What's included?
File/Folder | Description |
---|---|
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.
License
DocFX is licensed under the MIT license.
.NET Foundation
DocFX is supported by the .NET Foundation.