docfx 2.60.2

.NET 6.0 
dotnet tool install --global docfx --version 2.60.2
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local docfx --version 2.60.2
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=docfx&version=2.60.2
nuke :add-package docfx --version 2.60.2

Build your docs with docfx

NuGet Help Wanted Gitter

Build your technical documentation site with docfx, with landing pages, markdown, API reference docs for .NET, REST API and more.

⚠️⚠️⚠️ NOTICE ⚠️⚠️⚠️

For Microsoft Learn users, the open source version of docfx will NOT be maintained to support Microsoft Learn content. For Microsoft Learn feature requests, bug reports and other support ticks, use internal channels such as the Learn Platform Support Channel.

Getting Started

  1. Install docfx as a global tool:

    dotnet tool install -g docfx

  2. Create and start a website locally:

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

  3. Go to https://localhost:8080 to see the sample site.

For more information, refer to Getting Started.

Contributing

Use Discussions for questions and general discussions. Use Issues to report bugs and proposing features.

We welcome code contributions through pull requests, issues tagged as help-wanted are good candidate to start contributing code.

Prerequisites

Build and Test

  • Build site templates in templates directory:
    • Run npm install to restore npm dependencies.
    • Run npm run build to build the templates.
  • Run dotnet build to build the project or use Visual Studio to build docfx.sln.
  • Run dotnet test to test the project or use Visual Studio test explorer.

Branch and Release

The main branch is the default branch for pull requests and most other development activities. We occationally use feature/* branches for epic feature development.

Releases are based on a stable main branch commit using GitHub Releases. Release versioning follows Semantic Versioning. Use of Conventional Commit is encouraged.

Docfx is not released under a regular cadence, new versions arrive when maintainers see enough changes that warrant a new releases. Sometimes we use prereleases to dogfood breaking changes and get feedbacks from the community.

Roadmap

We use Milestones to communicate upcoming changes docfx:

  • Working Set are features being actively worked on. Not every features in this bucket will be committed in the next release but they reflect top of minds of maintainers in the upcoming period.

  • Backlog is a set of feature candidates for some future releases, but are not being actively worked on.

.NET Foundation

This project is supported by the .NET Foundation.

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

This project is licensed under the MIT License.

Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
2.60.2 1,572 1/20/2023
2.60.1 489 1/18/2023
2.60.0 1,138 1/13/2023
2.60.0-preview.2 465 12/25/2022
2.60.0-preview.1 267 12/20/2022
2.59.4 979 9/7/2022
2.59.3 779 7/6/2022
2.59.2 1,019 4/11/2022
2.59.1 507 3/31/2022
2.59.0 763 1/19/2022
2.58.9 886 11/4/2021
2.58.8 315 11/1/2021
2.58.5 339 10/26/2021
2.58.4 1,390 9/14/2021
2.58.3 577 9/7/2021
2.58.2 947 8/24/2021
2.58.1 330 8/23/2021
2.58.0 3,192 6/9/2021
2.57.2 1,438 4/14/2021
2.57.1 421 4/13/2021
2.57.0 504 4/9/2021
2.56.7 2,796 3/2/2021
2.56.6 4,063 12/10/2020
2.56.5 1,222 11/10/2020
2.56.4 864 10/20/2020
2.56.3 568 10/12/2020
2.56.2 2,182 7/27/2020
2.56.1 1,057 7/6/2020
2.56.0 782 6/29/2020
2.55.0 981 6/12/2020
2.53.1 2,059 5/11/2020
2.52.0 1,556 4/13/2020
2.51.0 1,409 3/20/2020
2.50.0 1,491 3/2/2020
2.49.0 628 2/17/2020
2.48.1 2,063 1/13/2020
2.48.0 1,897 12/9/2019
2.47.0 1,879 10/31/2019
2.46.0 1,227 10/14/2019
2.45.1 1,826 9/15/2019
2.45.0 1,463 8/25/2019
2.44.0 1,440 8/2/2019
2.43.2 2,158 7/2/2019
2.43.1 1,291 6/14/2019
2.42.4 2,166 5/24/2019
2.42.3 13,065 5/13/2019
2.42.2 728 5/10/2019
2.42.0 1,008 4/22/2019
2.41.0 1,804 3/29/2019
2.40.11 2,113 2/16/2019
2.40.10 1,698 2/1/2019
2.40.9 779 1/31/2019
2.40.8 1,323 1/25/2019
2.40.7 2,534 1/4/2019
2.40.5 816 12/19/2018
2.40.4 2,634 11/26/2018
2.40.2 1,719 11/7/2018
2.40.1 1,362 10/29/2018
2.40.0 1,956 10/12/2018
2.39.2 3,001 9/9/2018
2.39.1 1,121 9/4/2018
2.39.0 1,123 9/2/2018
2.38.1 6,033 8/16/2018
2.38.0 1,642 8/13/2018
2.37.2 1,698 7/31/2018
2.37.1 986 7/31/2018
2.36.2 1,294 6/13/2018
2.36.1 1,182 5/25/2018
2.36.0 1,090 5/21/2018
2.36.0-alpha-0159-g25e5900b4 866 4/26/2018
2.35.4 1,218 5/2/2018
2.35.3 1,113 5/2/2018
2.35.0-alpha-0153-g6da267dd4 840 4/25/2018
2.33.2 1,277 4/3/2018
2.33.1 1,085 4/3/2018
2.33.0 1,192 3/19/2018
2.32.2 1,063 3/12/2018
2.32.0 1,184 2/28/2018
2.31.0 1,245 2/5/2018
2.30.0 1,212 1/12/2018
2.29.1 1,125 12/29/2017
2.28.3 1,081 12/14/2017
2.28.2 1,152 12/7/2017
2.28.1 1,051 12/1/2017
2.28.0 1,057 11/30/2017
2.27.0 1,051 11/21/2017
2.26.3 1,150 10/26/2017
2.26.1 1,017 10/24/2017
2.26.0 1,021 10/23/2017
2.25.1 1,062 10/9/2017
2.25.0 1,016 10/9/2017
2.24.0 1,180 9/11/2017
2.23.1 1,136 8/22/2017
2.22.3 1,032 8/17/2017
2.22.1 1,074 8/2/2017
2.22.0 1,082 8/1/2017
2.21.2 1,033 7/26/2017
2.21.1 1,118 7/17/2017
2.20.0 1,091 7/12/2017
2.19.2 1,081 6/29/2017
2.18.5 1,113 6/15/2017
2.18.4 1,058 6/9/2017
2.18.3 1,076 6/8/2017
2.18.1 1,064 5/31/2017
2.17.5 1,087 5/23/2017
2.17.3 1,058 5/11/2017
2.17.2 1,047 5/9/2017
2.16.8 1,088 5/3/2017
2.16.7 1,066 4/26/2017
2.16.5 1,045 4/25/2017
2.16.2 1,041 4/20/2017
2.16.0 1,085 4/17/2017
2.15.5 1,183 4/6/2017
2.15.2 1,069 3/29/2017
2.13.1 1,108 3/7/2017
2.13.0 1,099 3/6/2017
2.12.1 1,115 2/14/2017
2.12.0 1,077 2/13/2017
2.11.3 1,086 2/7/2017
2.11.2 1,070 1/25/2017
2.11.1 1,078 1/24/2017
2.11.0 1,071 1/23/2017
2.10.2 1,111 1/4/2017
2.10.1 1,053 1/4/2017
2.10.0 1,105 1/3/2017
2.9.3 1,086 12/15/2016
2.9.2 1,088 12/14/2016
2.9.1 1,051 12/13/2016
2.9.0 1,085 12/12/2016
2.8.2 1,106 11/28/2016
2.8.1 1,079 11/24/2016
2.8.0 1,091 11/22/2016
2.7.3 1,373 11/8/2016
2.7.2 1,321 11/3/2016
2.7.1 1,327 11/1/2016
2.7.0 1,089 10/31/2016
2.6.3 1,124 10/25/2016
2.6.1 1,065 10/11/2016
2.6.0 1,080 10/10/2016
2.5.4 1,528 9/22/2016
2.5.3 1,448 9/20/2016
2.5.2 1,243 9/19/2016
2.5.1 1,320 9/19/2016
2.5.0 1,102 9/14/2016
2.4.0 1,154 8/29/2016
2.3.1 1,088 8/22/2016
2.3.0 1,220 8/8/2016
2.2.2 1,122 7/22/2016
2.2.1 1,105 7/19/2016
2.2.0 1,123 7/18/2016
2.1.0 1,211 6/27/2016
2.0.2 1,078 6/22/2016
2.0.1 1,119 6/7/2016
2.0.0 1,158 6/6/2016
1.9.4 1,447 5/19/2016
1.9.3 1,088 5/19/2016
1.9.0 1,072 5/16/2016
1.8.4 1,098 5/10/2016
1.8.1 1,098 5/4/2016
1.8.0 1,361 4/25/2016
1.7.2 1,138 4/20/2016
1.7.1 1,116 4/7/2016
1.7.0 1,092 4/6/2016
1.6.1 1,152 3/16/2016
1.5.0 1,186 2/22/2016
1.4.2 1,154 2/3/2016
1.4.1 1,087 2/2/2016
1.4.0 1,113 2/1/2016
1.3.7 1,142 1/21/2016
1.3.5 1,136 1/13/2016
1.3.3 1,270 1/13/2016
1.3.0 1,157 1/11/2016
1.2.2 1,182 12/30/2015
1.2.1 1,123 12/15/2015
1.2.0 1,354 12/14/2015
1.1.0 1,143 12/9/2015
1.0.0 1,367 11/20/2015
0.3.11-alpha-9-gdaed198 956 11/16/2015
0.3.0 1,202 11/12/2015
0.0.1-alpha-1523061607 967 6/23/2015
0.0.1-alpha-1523061604 963 6/23/2015
0.0.1-alpha-1518061325 905 6/18/2015
0.0.1-alpha-1518061107 902 6/18/2015
0.0.1-alpha-1517061543 904 6/17/2015
0.0.1-alpha-1517061409 978 6/17/2015