| | Windows |
| ---------- | --------- | ------
| master |
| dev |
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:
- Exe version which can be used as a command-line tool or inside VS IDE.
- DNX version which can be run cross platform.
We currently support C# and VB projects.
- VS 2015 community or above
- DNVM
dnvm install 1.0.0-rc1-final- Run
build.cmdunder DocFX code repo
Possible build issues
- 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.
- Test failure with message
\r\nnot equal to\nfor Windows Setgit config --global core.autocrlf true
Please refer to Getting Started.
| 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 |
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.
DocFX is licensed under the MIT license.
DocFX is supported by the .NET Foundation.