yufeih / docfx

Tools for building and publishing API documentation for .NET projects

Generate your API documentation with DocFX

• Build Status

	Build Status	Package	Chocolatey
master
dev

• Running Status

Running Status	Windows with .NET Core v2.0.3	Windows with VS2017	Ubuntu Linux with Mono	Mac with Mono

What's next?

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?

Prerequisites

1. Visual Studio 2017, minimum installation is enough.
2. Node.js, for building templates.

Steps

1. Option 1: Run build.cmd under DocFX code repo.
2. Option 2: Open All.sln under DocFX code repo in Visual Studio and build All.sln.

How do I play with DocFX?

1. Option 1: install DocFX through chocolatey package: choco install docfx -y.
2. Option 2: install DocFX through nuget package: nuget install docfx.console, docfx.exe is under folder docfx.console/tools/.
3. Option 3: play DocFX inside Visual Studio: create a Class Library (.NET Framework) project, Manage Nuget Packages to install docfx.console nuget package on the project, Build to create the generated website under folder _site.

For more information, please refer to Getting Started.

Integrate with Continuous Integration environment

1. Install DocFX through chocolatey package choco install docfx -y

2. 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 causes docfx 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.

Contributors & Thank You

Many thanks go to our community of developers who helped improve the quality of DocFX through their code contributions. Contributors:

License

DocFX is licensed under the MIT license.

.NET Foundation

DocFX is supported by the .NET Foundation.