Skip to content
Tools for building and publishing API documentation for .NET projects
C# F# JavaScript CSS PowerShell TypeScript Other
Branch: dev
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github extend stale time Apr 2, 2020
Documentation Quick typo fix that was bothering me (#5577) Feb 27, 2020
plugins DocumentException in DocFX v2 should be user error. (#5662) Mar 25, 2020
schemas/v1.0 Add schema validation when loading the schema based document model (#… Sep 7, 2017
src return -1 for user error (#5734) Apr 7, 2020
test skip log InvalidInputFile error if from DocumentException (#5702) Apr 1, 2020
tools publish to another 2 nuget feeds (#5608) Mar 10, 2020
.gitattributes Use CRLF as EOL (#3566) Nov 12, 2018
.gitignore Use CRLF as EOL (#3566) Nov 12, 2018
.vsconfig add fsharp into .vsconfig (#5031) Aug 28, 2019
CODE-OF-CONDUCT.md Link Code of Conduct (#5724) Apr 3, 2020
FSharpProjects.code-workspace F# metadata extractor unit tests (#2560) Mar 30, 2018
LICENSE update nuget source Jul 24, 2015
NuGet.config Update to latest FSharp.Compiler.Service (#5637) Mar 22, 2020
README.md Update README.md Feb 26, 2020
RELEASENOTE.md Pre-release 2.52 Mar 20, 2020
Roadmap.md Update Roadmap.md Jan 16, 2019
SECURITY.MD docs: add SECURITY.md (#5067) Sep 5, 2019
UpdateTemplate.cmd Add Linux support to build scripts. (#2470) Apr 9, 2018
UpdateTemplate.ps1
UpdateTemplate.sh Add Linux support to build scripts. (#2470) Apr 9, 2018
appveyor.yml Update appveyor.yml Mar 30, 2018
azure-pipelines-master.yml also publish packages to azdevops (#5587) Mar 3, 2020
azure-pipelines-stable.yml also publish packages to azdevops (#5587) Mar 3, 2020
azure-pipelines.yml test: remove selenium based test (#5192) Oct 14, 2019
build.cmd Migrate tools to .NET Core (#697) Sep 14, 2016
build.ps1 fix(ci): dotnet pack fails since msbuild 16.3.0 with --no-build (#5186) Oct 11, 2019
build.sh Add Linux support to build scripts. (#2470) Apr 9, 2018
docfx.sln

README.md

Generate your API documentation with DocFX

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

What's it

DocFX makes it extremely easy to generate your developer hub with API reference, landing page, and how-to.

What's next

Check out the road map of DocFX here. For more information on DocFX v3, please visit the v3 working branch.

Quick Start

choco install docfx
docfx init -q
docfx docfx_project\docfx.json --serve

For more information, please refer to Getting Started.

How to Contribute

For new comers, you can start with issues with help-wanted. 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.

DocFX Project

dev is the default branch accepting Pull Requests. It releases a package daily. master branch is the release branch.

How to build from source code

Prerequisites

  1. Visual Studio 2019 with .NET Core cross-platform development toolset
  2. Node.js

Steps

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

Build Status

master dev
Build Status Build Status

Packages

Chocolatey Nuget Nightly Build
Chocolatey NuGet MyGet

Running Status

Windows with VS2017 Ubuntu Linux with Mono
VS Ubuntu
You can’t perform that action at this time.