docfx 2.76.0

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 
dotnet tool install --global docfx --version 2.76.0
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.76.0
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=docfx&version=2.76.0
nuke :add-package docfx --version 2.76.0

Build your docs with docfx

NuGet Help Wanted

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

As you may have heard docfx has been transitioned to be a .NET Foundation project. Microsoft Learn no longer uses docfx and do not intend to support the project since Nov 2022.

Docfx is planned to continue as a community-driven project. We hope to produce future releases with new features and enhancements to support existing and new use cases. We also would like to invite any interested parties to be involved in this project. If you'd like to contact the community team please open a discussion thread.

Getting Started

  1. Install docfx as a global tool:

    dotnet tool install -g docfx

  2. Create and start a website locally:

    docfx init -y
docfx build docfx_project\docfx.json --serve

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

For more information, refer to Getting Started.

[!TIP] Docfx publishes nightly builds to GitHub Packages, this allows you to stay up-to-date with the latest developments in Docfx.

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.
    • Run git lfs checkout to checkout files for snapshot testing

Branch and Release

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

Releases are based on a stable main branch commit using GitHub Releases. 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.

License

This project is licensed under the MIT License.

.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.

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 is compatible.  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 is compatible.  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 89,524 4/7/2024
2.75.3 122,325 2/18/2024
2.75.2 42,727 1/27/2024
2.75.1 40,654 1/13/2024
2.75.0 2,106 1/12/2024
2.74.1 97,977 11/30/2023
2.74.0 36,448 11/20/2023
2.73.2 19,701 11/13/2023
2.73.1 7,231 11/7/2023
2.73.0 8,903 11/2/2023
2.72.1 10,360 10/28/2023
2.72.0 9,382 10/24/2023
2.71.1 7,694 10/18/2023
2.71.0 31,299 9/30/2023
2.70.4 20,327 9/18/2023
2.70.3 25,892 9/5/2023
2.70.2 1,446 9/4/2023
2.70.1 15,636 8/21/2023
2.70.0 35,144 8/2/2023
2.67.5 71,885 6/21/2023
2.67.3 20,972 6/2/2023
2.67.2 6,130 5/26/2023
2.67.1 34,138 5/16/2023
2.67.0 14,880 5/6/2023
2.66.2 19,697 4/26/2023
2.66.1 1,775 4/25/2023
2.66.0 2,011 4/24/2023
2.65.3 12,269 4/14/2023
2.65.2 5,029 4/11/2023
2.65.1 2,152 4/9/2023
2.65.0 1,832 4/7/2023
2.64.0 34,700 3/30/2023
2.63.1 9,237 3/21/2023
2.63.0 1,464 3/20/2023
2.62.2 13,165 3/7/2023
2.62.1 16,435 2/15/2023
2.62.0 1,118 2/14/2023
2.61.0 47,721 1/30/2023
2.60.2 27,880 1/20/2023
2.60.1 3,628 1/18/2023
2.60.0 3,140 1/13/2023
2.60.0-preview.2 816 12/25/2022
2.60.0-preview.1 651 12/20/2022
2.59.4 5,519 9/7/2022
2.59.3 1,285 7/6/2022
2.59.2 1,515 4/11/2022
2.59.1 740 3/31/2022
2.59.0 1,223 1/19/2022
2.58.9 1,095 11/4/2021
2.58.8 496 11/1/2021
2.58.5 496 10/26/2021
2.58.4 1,556 9/14/2021
2.58.3 726 9/7/2021
2.58.2 1,103 8/24/2021
2.58.1 500 8/23/2021
2.58.0 3,418 6/9/2021
2.57.2 1,624 4/14/2021
2.57.1 573 4/13/2021
2.57.0 640 4/9/2021
2.56.7 3,212 3/2/2021
2.56.6 4,211 12/10/2020
2.56.5 1,387 11/10/2020
2.56.4 1,032 10/20/2020
2.56.3 734 10/12/2020
2.56.2 2,354 7/27/2020
2.56.1 1,222 7/6/2020
2.56.0 933 6/29/2020
2.55.0 1,179 6/12/2020
2.53.1 2,285 5/11/2020
2.52.0 1,751 4/13/2020
2.51.0 1,598 3/20/2020
2.50.0 1,711 3/2/2020
2.49.0 810 2/17/2020
2.48.1 2,855 1/13/2020
2.48.0 2,073 12/9/2019
2.47.0 2,086 10/31/2019
2.46.0 1,406 10/14/2019
2.45.1 2,005 9/15/2019
2.45.0 1,603 8/25/2019
2.44.0 1,599 8/2/2019
2.43.2 2,310 7/2/2019
2.43.1 1,446 6/14/2019
2.42.4 2,332 5/24/2019
2.42.3 13,234 5/13/2019
2.42.2 878 5/10/2019
2.42.0 1,163 4/22/2019
2.41.0 1,984 3/29/2019
2.40.11 2,311 2/16/2019
2.40.10 1,883 2/1/2019
2.40.9 959 1/31/2019
2.40.8 1,483 1/25/2019
2.40.7 2,692 1/4/2019
2.40.5 969 12/19/2018
2.40.4 2,792 11/26/2018
2.40.2 1,883 11/7/2018
2.40.1 1,524 10/29/2018
2.40.0 2,170 10/12/2018
2.39.2 3,181 9/9/2018
2.39.1 1,280 9/4/2018
2.39.0 1,296 9/2/2018
2.38.1 6,228 8/16/2018
2.38.0 1,827 8/13/2018
2.37.2 1,894 7/31/2018
2.37.1 1,178 7/31/2018
2.36.2 1,465 6/13/2018
2.36.1 1,515 5/25/2018
2.36.0 1,280 5/21/2018
2.36.0-alpha-0159-g25e5900b4 958 4/26/2018
2.35.4 1,426 5/2/2018
2.35.3 1,298 5/2/2018
2.35.0-alpha-0153-g6da267dd4 960 4/25/2018
2.33.2 1,446 4/3/2018
2.33.1 1,282 4/3/2018
2.33.0 1,405 3/19/2018
2.32.2 1,219 3/12/2018
2.32.0 1,365 2/28/2018
2.31.0 1,474 2/5/2018
2.30.0 1,462 1/12/2018
2.29.1 1,323 12/29/2017
2.28.3 1,273 12/14/2017
2.28.2 1,341 12/7/2017
2.28.1 1,234 12/1/2017
2.28.0 1,238 11/30/2017
2.27.0 1,241 11/21/2017
2.26.3 1,336 10/26/2017
2.26.1 1,220 10/24/2017
2.26.0 1,208 10/23/2017
2.25.1 1,240 10/9/2017
2.25.0 1,213 10/9/2017
2.24.0 1,411 9/11/2017
2.23.1 1,338 8/22/2017
2.22.3 1,233 8/17/2017
2.22.1 1,242 8/2/2017
2.22.0 1,257 8/1/2017
2.21.2 1,226 7/26/2017
2.21.1 1,326 7/17/2017
2.20.0 1,291 7/12/2017
2.19.2 1,271 6/29/2017
2.18.5 1,314 6/15/2017
2.18.4 1,269 6/9/2017
2.18.3 1,272 6/8/2017
2.18.1 1,228 5/31/2017
2.17.5 1,259 5/23/2017
2.17.3 1,251 5/11/2017
2.17.2 1,242 5/9/2017
2.16.8 1,284 5/3/2017
2.16.7 1,249 4/26/2017
2.16.5 1,227 4/25/2017
2.16.2 1,250 4/20/2017
2.16.0 1,297 4/17/2017
2.15.5 1,382 4/6/2017
2.15.2 1,265 3/29/2017
2.13.1 1,305 3/7/2017
2.13.0 1,302 3/6/2017
2.12.1 1,320 2/14/2017
2.12.0 1,271 2/13/2017
2.11.3 1,306 2/7/2017
2.11.2 1,279 1/25/2017
2.11.1 1,244 1/24/2017
2.11.0 1,242 1/23/2017
2.10.2 1,269 1/4/2017
2.10.1 1,226 1/4/2017
2.10.0 1,295 1/3/2017
2.9.3 1,245 12/15/2016
2.9.2 1,269 12/14/2016
2.9.1 1,223 12/13/2016
2.9.0 1,298 12/12/2016
2.8.2 1,290 11/28/2016
2.8.1 1,265 11/24/2016
2.8.0 1,292 11/22/2016
2.7.3 1,573 11/8/2016
2.7.2 1,514 11/3/2016
2.7.1 1,501 11/1/2016
2.7.0 1,306 10/31/2016
2.6.3 1,334 10/25/2016
2.6.1 1,275 10/11/2016
2.6.0 1,296 10/10/2016
2.5.4 1,770 9/22/2016
2.5.3 1,643 9/20/2016
2.5.2 1,424 9/19/2016
2.5.1 1,529 9/19/2016
2.5.0 1,316 9/14/2016
2.4.0 1,377 8/29/2016
2.3.1 1,320 8/22/2016
2.3.0 1,432 8/8/2016
2.2.2 1,335 7/22/2016
2.2.1 1,319 7/19/2016
2.2.0 1,317 7/18/2016
2.1.0 1,431 6/27/2016
2.0.2 1,270 6/22/2016
2.0.1 1,314 6/7/2016
2.0.0 1,401 6/6/2016
1.9.4 1,662 5/19/2016
1.9.3 1,292 5/19/2016
1.9.0 1,246 5/16/2016
1.8.4 1,289 5/10/2016
1.8.1 1,283 5/4/2016
1.8.0 1,556 4/25/2016
1.7.2 1,334 4/20/2016
1.7.1 1,298 4/7/2016
1.7.0 1,273 4/6/2016
1.6.1 1,336 3/16/2016
1.5.0 1,378 2/22/2016
1.4.2 1,355 2/3/2016
1.4.1 1,292 2/2/2016
1.4.0 1,319 2/1/2016
1.3.7 1,340 1/21/2016
1.3.5 1,336 1/13/2016
1.3.3 1,458 1/13/2016
1.3.0 1,319 1/11/2016
1.2.2 1,374 12/30/2015
1.2.1 1,301 12/15/2015
1.2.0 1,824 12/14/2015
1.1.0 1,347 12/9/2015
1.0.0 1,555 11/20/2015
0.3.11-alpha-9-gdaed198 1,048 11/16/2015
0.3.0 1,421 11/12/2015
0.0.1-alpha-1523061607 1,094 6/23/2015
0.0.1-alpha-1523061604 1,062 6/23/2015
0.0.1-alpha-1518061325 1,028 6/18/2015
0.0.1-alpha-1518061107 991 6/18/2015
0.0.1-alpha-1517061543 1,069 6/17/2015
0.0.1-alpha-1517061409 1,112 6/17/2015