Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 2.88 KB

README.md

File metadata and controls

57 lines (44 loc) · 2.88 KB
Raw

Generate your API documentation with DocFX

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

| | Windows | | ---------- | --------- | ------ | master | masterstatus | dev | devstatus

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 2015 community or above
  2. DNVM

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