Tools for building and publishing API documentation for .NET projects
C# JavaScript CSS HTML TypeScript PowerShell Other
Latest commit 813818f Feb 21, 2017 @vwxyzh vwxyzh committed with hellosnow add modify in ManifestFileHelper. (#1330)
* add modify in ManifestFileHelper.

* remove check.

README.md

Generate your API documentation with DocFX

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

Build Status Package Chocolatey
master masterstatus NuGet Chocolatey
dev devstatus MyGet

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. Microsoft Build Tools 2015
  2. .NET Core 1.0.0 SDK 1.0.0-preview2-003121 x86 | x64
  3. Node.js

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.

Possible build issues

  1. 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.

Integrate with Continuous Integration environment

  1. Install docfx through chocolatey package cinst 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. https://github.com/dotnet/docfx/issues/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.