Name: docfx
Owner: .NET Foundation
Description: Tools for building and publishing API documentation for .NET projects
Created: 2015-06-24 19:43:53.0
Updated: 2018-05-24 07:25:32.0
Pushed: 2018-05-24 08:21:51.0
Homepage: http://dotnet.github.io/docfx/
Size: 332730
Language: C#
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
| | Build Status | Package | Chocolatey | | ———- | ————- | ———- | ———– | | master | | | | dev | |
| Running Status| Windows with .NET Core v2.0.3| Windows with VS2017 | Ubuntu Linux with Mono | Mac with Mono | ———- | ————- |———- | ————- |———- | ||||
Let's make DocFX better together!
Vote for the proposals you like, and add yours:
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.
build.cmd
under DocFX code repo.All.sln
under DocFX code repo in Visual Studio and build All.sln.choco install docfx -y
.nuget install docfx.console
, docfx.exe
is under folder docfx.console/tools/.docfx.console
nuget package on the project, Build to create the generated website under folder _site
.For more information, please refer to Getting Started.
Install docfx through chocolatey package
choco install docfx -y
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 causesdocfx metadata
failure. https://github.com/dotnet/docfx/issues/1078
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.
Thanks goes to our community of developers who helped improve the quality of DocFX through their code contributions. Contributors:
DocFX is licensed under the MIT license.
DocFX is supported by the .NET Foundation.