docfx 2.60.0-preview.2

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET 6.0
This is a prerelease version of docfx.
There is a newer version of this package available.
See the version list below for details. 
dotnet tool install --global docfx --version 2.60.0-preview.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.0-preview.2
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=docfx&version=2.60.0-preview.2&prerelease
nuke :add-package docfx --version 2.60.0-preview.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 using choco:

    choco install 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 Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
2.76.0 44,017 4/7/2024
2.75.3 112,831 2/18/2024
2.75.2 39,918 1/27/2024
2.75.1 34,061 1/13/2024
2.75.0 1,802 1/12/2024
2.74.1 92,472 11/30/2023
2.74.0 35,359 11/20/2023
2.73.2 18,034 11/13/2023
2.73.1 7,017 11/7/2023
2.73.0 8,806 11/2/2023
2.72.1 10,135 10/28/2023
2.72.0 9,231 10/24/2023
2.71.1 7,446 10/18/2023
2.71.0 30,539 9/30/2023
2.70.4 19,213 9/18/2023
2.70.3 24,632 9/5/2023
2.70.2 1,438 9/4/2023
2.70.1 15,450 8/21/2023
2.70.0 34,051 8/2/2023
2.67.5 70,646 6/21/2023
2.67.3 20,627 6/2/2023
2.67.2 6,116 5/26/2023
2.67.1 33,858 5/16/2023
2.67.0 14,821 5/6/2023
2.66.2 19,008 4/26/2023
2.66.1 1,763 4/25/2023
2.66.0 1,999 4/24/2023
2.65.3 12,176 4/14/2023
2.65.2 5,016 4/11/2023
2.65.1 2,136 4/9/2023
2.65.0 1,820 4/7/2023
2.64.0 34,042 3/30/2023
2.63.1 9,220 3/21/2023
2.63.0 1,455 3/20/2023
2.62.2 13,141 3/7/2023
2.62.1 16,111 2/15/2023
2.62.0 1,104 2/14/2023
2.61.0 45,714 1/30/2023
2.60.2 27,047 1/20/2023
2.60.1 3,544 1/18/2023
2.60.0 3,109 1/13/2023
2.60.0-preview.2 815 12/25/2022
2.60.0-preview.1 651 12/20/2022
2.59.4 5,301 9/7/2022
2.59.3 1,281 7/6/2022
2.59.2 1,509 4/11/2022
2.59.1 739 3/31/2022
2.59.0 1,203 1/19/2022
2.58.9 1,094 11/4/2021
2.58.8 496 11/1/2021
2.58.5 495 10/26/2021
2.58.4 1,554 9/14/2021
2.58.3 726 9/7/2021
2.58.2 1,101 8/24/2021
2.58.1 500 8/23/2021
2.58.0 3,413 6/9/2021
2.57.2 1,623 4/14/2021
2.57.1 573 4/13/2021
2.57.0 640 4/9/2021
2.56.7 3,208 3/2/2021
2.56.6 4,210 12/10/2020
2.56.5 1,384 11/10/2020
2.56.4 1,030 10/20/2020
2.56.3 734 10/12/2020
2.56.2 2,353 7/27/2020
2.56.1 1,222 7/6/2020
2.56.0 930 6/29/2020
2.55.0 1,176 6/12/2020
2.53.1 2,280 5/11/2020
2.52.0 1,748 4/13/2020
2.51.0 1,597 3/20/2020
2.50.0 1,703 3/2/2020
2.49.0 809 2/17/2020
2.48.1 2,820 1/13/2020
2.48.0 2,070 12/9/2019
2.47.0 2,085 10/31/2019
2.46.0 1,405 10/14/2019
2.45.1 2,004 9/15/2019
2.45.0 1,602 8/25/2019
2.44.0 1,598 8/2/2019
2.43.2 2,309 7/2/2019
2.43.1 1,445 6/14/2019
2.42.4 2,331 5/24/2019
2.42.3 13,234 5/13/2019
2.42.2 878 5/10/2019
2.42.0 1,162 4/22/2019
2.41.0 1,983 3/29/2019
2.40.11 2,308 2/16/2019
2.40.10 1,881 2/1/2019
2.40.9 956 1/31/2019
2.40.8 1,481 1/25/2019
2.40.7 2,690 1/4/2019
2.40.5 966 12/19/2018
2.40.4 2,789 11/26/2018
2.40.2 1,881 11/7/2018
2.40.1 1,521 10/29/2018
2.40.0 2,165 10/12/2018
2.39.2 3,178 9/9/2018
2.39.1 1,278 9/4/2018
2.39.0 1,294 9/2/2018
2.38.1 6,225 8/16/2018
2.38.0 1,825 8/13/2018
2.37.2 1,889 7/31/2018
2.37.1 1,174 7/31/2018
2.36.2 1,459 6/13/2018
2.36.1 1,510 5/25/2018
2.36.0 1,276 5/21/2018
2.36.0-alpha-0159-g25e5900b4 955 4/26/2018
2.35.4 1,421 5/2/2018
2.35.3 1,294 5/2/2018
2.35.0-alpha-0153-g6da267dd4 957 4/25/2018
2.33.2 1,440 4/3/2018
2.33.1 1,278 4/3/2018
2.33.0 1,400 3/19/2018
2.32.2 1,214 3/12/2018
2.32.0 1,360 2/28/2018
2.31.0 1,469 2/5/2018
2.30.0 1,457 1/12/2018
2.29.1 1,318 12/29/2017
2.28.3 1,268 12/14/2017
2.28.2 1,337 12/7/2017
2.28.1 1,230 12/1/2017
2.28.0 1,233 11/30/2017
2.27.0 1,236 11/21/2017
2.26.3 1,331 10/26/2017
2.26.1 1,215 10/24/2017
2.26.0 1,204 10/23/2017
2.25.1 1,235 10/9/2017
2.25.0 1,209 10/9/2017
2.24.0 1,405 9/11/2017
2.23.1 1,333 8/22/2017
2.22.3 1,228 8/17/2017
2.22.1 1,238 8/2/2017
2.22.0 1,253 8/1/2017
2.21.2 1,221 7/26/2017
2.21.1 1,322 7/17/2017
2.20.0 1,286 7/12/2017
2.19.2 1,266 6/29/2017
2.18.5 1,309 6/15/2017
2.18.4 1,265 6/9/2017
2.18.3 1,268 6/8/2017
2.18.1 1,223 5/31/2017
2.17.5 1,254 5/23/2017
2.17.3 1,247 5/11/2017
2.17.2 1,238 5/9/2017
2.16.8 1,279 5/3/2017
2.16.7 1,244 4/26/2017
2.16.5 1,223 4/25/2017
2.16.2 1,246 4/20/2017
2.16.0 1,293 4/17/2017
2.15.5 1,377 4/6/2017
2.15.2 1,260 3/29/2017
2.13.1 1,301 3/7/2017
2.13.0 1,298 3/6/2017
2.12.1 1,315 2/14/2017
2.12.0 1,266 2/13/2017
2.11.3 1,301 2/7/2017
2.11.2 1,274 1/25/2017
2.11.1 1,241 1/24/2017
2.11.0 1,238 1/23/2017
2.10.2 1,264 1/4/2017
2.10.1 1,222 1/4/2017
2.10.0 1,290 1/3/2017
2.9.3 1,240 12/15/2016
2.9.2 1,265 12/14/2016
2.9.1 1,219 12/13/2016
2.9.0 1,294 12/12/2016
2.8.2 1,286 11/28/2016
2.8.1 1,261 11/24/2016
2.8.0 1,288 11/22/2016
2.7.3 1,568 11/8/2016
2.7.2 1,510 11/3/2016
2.7.1 1,497 11/1/2016
2.7.0 1,297 10/31/2016
2.6.3 1,329 10/25/2016
2.6.1 1,269 10/11/2016
2.6.0 1,290 10/10/2016
2.5.4 1,763 9/22/2016
2.5.3 1,636 9/20/2016
2.5.2 1,418 9/19/2016
2.5.1 1,523 9/19/2016
2.5.0 1,312 9/14/2016
2.4.0 1,371 8/29/2016
2.3.1 1,315 8/22/2016
2.3.0 1,428 8/8/2016
2.2.2 1,330 7/22/2016
2.2.1 1,315 7/19/2016
2.2.0 1,313 7/18/2016
2.1.0 1,425 6/27/2016
2.0.2 1,265 6/22/2016
2.0.1 1,310 6/7/2016
2.0.0 1,394 6/6/2016
1.9.4 1,657 5/19/2016
1.9.3 1,286 5/19/2016
1.9.0 1,242 5/16/2016
1.8.4 1,284 5/10/2016
1.8.1 1,279 5/4/2016
1.8.0 1,550 4/25/2016
1.7.2 1,328 4/20/2016
1.7.1 1,294 4/7/2016
1.7.0 1,269 4/6/2016
1.6.1 1,329 3/16/2016
1.5.0 1,371 2/22/2016
1.4.2 1,348 2/3/2016
1.4.1 1,286 2/2/2016
1.4.0 1,313 2/1/2016
1.3.7 1,333 1/21/2016
1.3.5 1,330 1/13/2016
1.3.3 1,453 1/13/2016
1.3.0 1,313 1/11/2016
1.2.2 1,367 12/30/2015
1.2.1 1,296 12/15/2015
1.2.0 1,819 12/14/2015
1.1.0 1,340 12/9/2015
1.0.0 1,550 11/20/2015
0.3.11-alpha-9-gdaed198 1,043 11/16/2015
0.3.0 1,415 11/12/2015
0.0.1-alpha-1523061607 1,089 6/23/2015
0.0.1-alpha-1523061604 1,058 6/23/2015
0.0.1-alpha-1518061325 1,024 6/18/2015
0.0.1-alpha-1518061107 987 6/18/2015
0.0.1-alpha-1517061543 1,065 6/17/2015
0.0.1-alpha-1517061409 1,106 6/17/2015