Tools for building and publishing API documentation for .NET projects
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Documentation update document for use docfx in CI (#3929) Jan 17, 2019
plugins check duplicate name for all files when split class to member (#3486) Nov 6, 2018
schemas/v1.0 Add schema validation when loading the schema based document model (#… Sep 7, 2017
src Update TripleColonParser.cs for zone correct closed (#3930) Jan 18, 2019
test Update TripleColonParser.cs for zone correct closed (#3930) Jan 18, 2019
tools add back e2e tests (#3862) Jan 15, 2019
.gitattributes Use CRLF as EOL (#3566) Nov 12, 2018
.gitignore Use CRLF as EOL (#3566) Nov 12, 2018
All.sln #2960 Try to fix fsharp project loading (#2971) Jun 29, 2018
CODEOWNERS add mingwli as code owner (#3369) Sep 5, 2018
CONTRIBUTING.md Update CONTRIBUTING.md Feb 2, 2018
FSharpProjects.code-workspace F# metadata extractor unit tests (#2560) Mar 30, 2018
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE.md Jul 21, 2017
LICENSE update nuget source Jul 24, 2015
NuGet.config Fix 1969 by manually set vs 2017 path (#2242) Nov 29, 2017
README.md add status badge for stable branch (#3732) Dec 6, 2018
RELEASENOTE.md pre-release 2.41 Jan 4, 2019
Roadmap.md Update Roadmap.md Jan 16, 2019
UpdateTemplate.cmd Add Linux support to build scripts. (#2470) Apr 9, 2018
UpdateTemplate.ps1 Add Linux support to build scripts. (#2470) Apr 9, 2018
UpdateTemplate.sh Add Linux support to build scripts. (#2470) Apr 9, 2018
appveyor.yml Update appveyor.yml Mar 30, 2018
build.cmd Migrate tools to .NET Core (#697) Sep 14, 2016
build.ps1 Fix FSharp tests (#3729) Dec 10, 2018
build.sh Add Linux support to build scripts. (#2470) Apr 9, 2018
docfx.E2E.Tests.sln Update to vs17 (#1436) Mar 20, 2017
e2eTest.cmd add e2e tests Jan 4, 2016

README.md

Generate your API documentation with DocFX

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

  • Build Status
Build Status Package Chocolatey
master Master status NuGet Chocolatey
stable Build Status MyGet
dev devstatus
  • Running Status
Running Status Windows with .NET Core v2.0.3 Windows with VS2017 Ubuntu Linux with Mono Mac with Mono
NuGet .NET CORE VS Ubuntu Mac

What's next?

Check out the road map of DocFX here.

NOTE: For more information on DocFX v3, please visit the v3 working branch.

Collecting feedbacks and proposals for DocFX

Let's make DocFX better together!

Vote for the proposals you like, and add yours:

Feature Requests

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. Visual Studio 2017, minimum installation is enough.
  2. Node.js, for building templates.

Steps

  • Option 1: Run build.cmd under DocFX code repo.
  • Option 2: Open All.sln under DocFX code repo in Visual Studio and build All.sln.

How do I play with DocFX?

  • Option 1: install DocFX through chocolatey package: choco install docfx -y.
  • Option 2: install DocFX through nuget package: nuget install docfx.console, docfx.exe is under folder docfx.console/tools/.
  • Option 3: play DocFX inside Visual Studio: create a Class Library (.NET Framework) project, Manage Nuget Packages to install docfx.console nuget package on the project, Build to create the generated website under folder _site.

For more information, please refer to Getting Started.

Integrate with Continuous Integration environment

  1. Install DocFX through chocolatey package choco install 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.

Contributors & Thank You

Many thanks go to our community of developers who helped improve the quality of DocFX through their code contributions. Contributors:

License

DocFX is licensed under the MIT license.

.NET Foundation

DocFX is supported by the .NET Foundation.