Tools for building and publishing API documentation for .NET projects

Clone this repo:
  1. b3e858b Merge branch 'dev' of https://github.com/dotnet/docfx into dev by t-jipe@microsoft.com · 6 years ago dev
  2. 5308447 update build info. (#601) by vwxyzh · 6 years ago
  3. 1d6dab3 Rest - use jobject to judge whether a json is swagger, no need to deserialize whole file (#599) by Huang Xueyuan · 6 years ago
  4. 438e803 Merge branch 'dev' of github.com:dotnet/docfx into dev by t-jipe@microsoft.com · 6 years ago
  5. 81b6458 update document for validation. (#587) by vwxyzh · 6 years ago

Generate your API documentation with DocFX

Join the chat at https://gitter.im/dotnet/docfx Github All Releases

Build StatusPackageChocolatey
mastermasterstatusNuGetChocolatey
devdevstatusMyGet

What is it?

DocFX makes it extremely easy to generate your developer hub with API reference, landing page, and how-to. There are currently two versions of the tool:

  1. Exe version which can be used as a command-line tool or inside VS IDE.
  2. DNX version which can be run cross platform.

We currently support C# and VB projects.

How to build?

Prerequisites

  1. VS 2013 community or above
  2. Microsoft Build Tools 2015(No need if you install VS 2015 or above)
  3. DNVM
  4. Node.js

Steps

  1. dnvm install 1.0.0-rc1-final
  2. Run build.cmd under DocFX code repo

Possible build issues

  1. DNX.PackageManager not found Install http://www.microsoft.com/en-us/download/details.aspx?id=49442. Note that there are 2 msi to be installed.
  2. Test failure with message \r\n not equal to \n for Windows Set git config --global core.autocrlf true

How do I play with DocFX?

Please refer to Getting Started.

What's included?

File/FolderDescription
LICENSEProject license information
README.mdIntroduction to the project
CONTRIBUTING.mdContribution guidelines to how to contribute to the repo
DocumentationSource for our documentation site
srcSource code for DocFX
testTest cases for DocFX using xunit test framework
toolsSource 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.