docfx 2.75.2

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet tool install --global docfx --version 2.75.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.75.2
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=docfx&version=2.75.2                

                    
                

            
nuke :add-package docfx --version 2.75.2

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.

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.78.2 6,036 11/26/2024
2.78.1 12,495 11/19/2024
2.78.0 3,048 11/18/2024
2.77.0 299,071 7/1/2024
2.76.0 253,085 4/7/2024
2.75.3 208,620 2/18/2024
2.75.2 70,952 1/27/2024
2.75.1 92,895 1/13/2024
2.75.0 9,557 1/12/2024
2.74.1 146,337 11/30/2023
2.74.0 51,460 11/20/2023
2.73.2 31,052 11/13/2023
2.73.1 9,068 11/7/2023
2.73.0 9,509 11/2/2023
2.72.1 13,327 10/28/2023
2.72.0 10,649 10/24/2023
2.71.1 8,208 10/18/2023
2.71.0 37,562 9/30/2023
2.70.4 30,514 9/18/2023
2.70.3 39,230 9/5/2023
2.70.2 1,598 9/4/2023
2.70.1 17,038 8/21/2023
2.70.0 43,098 8/2/2023
2.67.5 82,132 6/21/2023
2.67.3 23,130 6/2/2023
2.67.2 6,433 5/26/2023
2.67.1 35,497 5/16/2023
2.67.0 15,460 5/6/2023
2.66.2 28,678 4/26/2023
2.66.1 1,911 4/25/2023
2.66.0 2,195 4/24/2023
2.65.3 12,968 4/14/2023
2.65.2 5,318 4/11/2023
2.65.1 2,965 4/9/2023
2.65.0 1,978 4/7/2023
2.64.0 49,187 3/30/2023
2.63.1 9,438 3/21/2023
2.63.0 1,554 3/20/2023
2.62.2 13,318 3/7/2023
2.62.1 19,219 2/15/2023
2.62.0 1,228 2/14/2023
2.61.0 62,705 1/30/2023
2.60.2 35,308 1/20/2023
2.60.1 5,765 1/18/2023
2.60.0 3,395 1/13/2023
2.60.0-preview.2 837 12/25/2022
2.60.0-preview.1 676 12/20/2022
2.59.4 7,197 9/7/2022
2.59.3 1,361 7/6/2022
2.59.2 1,578 4/11/2022
2.59.1 778 3/31/2022
2.59.0 1,303 1/19/2022
2.58.9 1,153 11/4/2021
2.58.8 536 11/1/2021
2.58.5 523 10/26/2021
2.58.4 1,610 9/14/2021
2.58.3 757 9/7/2021
2.58.2 1,136 8/24/2021
2.58.1 534 8/23/2021
2.58.0 3,463 6/9/2021
2.57.2 1,659 4/14/2021
2.57.1 612 4/13/2021
2.57.0 677 4/9/2021
2.56.7 3,254 3/2/2021
2.56.6 4,248 12/10/2020
2.56.5 1,420 11/10/2020
2.56.4 1,064 10/20/2020
2.56.3 767 10/12/2020
2.56.2 2,387 7/27/2020
2.56.1 1,256 7/6/2020
2.56.0 976 6/29/2020
2.55.0 1,214 6/12/2020
2.53.1 2,368 5/11/2020
2.52.0 1,822 4/13/2020
2.51.0 1,632 3/20/2020
2.50.0 1,763 3/2/2020
2.49.0 844 2/17/2020
2.48.1 2,927 1/13/2020
2.48.0 2,109 12/9/2019
2.47.0 2,120 10/31/2019
2.46.0 1,426 10/14/2019
2.45.1 2,040 9/15/2019
2.45.0 1,645 8/25/2019
2.44.0 1,631 8/2/2019
2.43.2 2,328 7/2/2019
2.43.1 1,477 6/14/2019
2.42.4 2,364 5/24/2019
2.42.3 13,267 5/13/2019
2.42.2 894 5/10/2019
2.42.0 1,195 4/22/2019
2.41.0 2,016 3/29/2019
2.40.11 2,356 2/16/2019
2.40.10 1,910 2/1/2019
2.40.9 986 1/31/2019
2.40.8 1,505 1/25/2019
2.40.7 2,722 1/4/2019
2.40.5 995 12/19/2018
2.40.4 2,824 11/26/2018
2.40.2 1,920 11/7/2018
2.40.1 1,554 10/29/2018
2.40.0 2,225 10/12/2018
2.39.2 3,210 9/9/2018
2.39.1 1,314 9/4/2018
2.39.0 1,330 9/2/2018
2.38.1 6,260 8/16/2018
2.38.0 1,855 8/13/2018
2.37.2 1,925 7/31/2018
2.37.1 1,209 7/31/2018
2.36.2 1,499 6/13/2018
2.36.1 1,549 5/25/2018
2.36.0 1,316 5/21/2018
2.36.0-alpha-0159-g25e5900b4 988 4/26/2018
2.35.4 1,469 5/2/2018
2.35.3 1,335 5/2/2018
2.35.0-alpha-0153-g6da267dd4 992 4/25/2018
2.33.2 1,476 4/3/2018
2.33.1 1,322 4/3/2018
2.33.0 1,441 3/19/2018
2.32.2 1,253 3/12/2018
2.32.0 1,403 2/28/2018
2.31.0 1,519 2/5/2018
2.30.0 1,500 1/12/2018
2.29.1 1,355 12/29/2017
2.28.3 1,310 12/14/2017
2.28.2 1,372 12/7/2017
2.28.1 1,271 12/1/2017
2.28.0 1,271 11/30/2017
2.27.0 1,283 11/21/2017
2.26.3 1,368 10/26/2017
2.26.1 1,256 10/24/2017
2.26.0 1,247 10/23/2017
2.25.1 1,274 10/9/2017
2.25.0 1,248 10/9/2017
2.24.0 1,448 9/11/2017
2.23.1 1,374 8/22/2017
2.22.3 1,263 8/17/2017
2.22.1 1,280 8/2/2017
2.22.0 1,296 8/1/2017
2.21.2 1,260 7/26/2017
2.21.1 1,363 7/17/2017
2.20.0 1,334 7/12/2017
2.19.2 1,317 6/29/2017
2.18.5 1,348 6/15/2017
2.18.4 1,303 6/9/2017
2.18.3 1,309 6/8/2017
2.18.1 1,261 5/31/2017
2.17.5 1,291 5/23/2017
2.17.3 1,283 5/11/2017
2.17.2 1,279 5/9/2017
2.16.8 1,319 5/3/2017
2.16.7 1,282 4/26/2017
2.16.5 1,259 4/25/2017
2.16.2 1,285 4/20/2017
2.16.0 1,337 4/17/2017
2.15.5 1,403 4/6/2017
2.15.2 1,310 3/29/2017
2.13.1 1,344 3/7/2017
2.13.0 1,333 3/6/2017
2.12.1 1,356 2/14/2017
2.12.0 1,307 2/13/2017
2.11.3 1,342 2/7/2017
2.11.2 1,312 1/25/2017
2.11.1 1,281 1/24/2017
2.11.0 1,277 1/23/2017
2.10.2 1,306 1/4/2017
2.10.1 1,263 1/4/2017
2.10.0 1,372 1/3/2017
2.9.3 1,279 12/15/2016
2.9.2 1,307 12/14/2016
2.9.1 1,259 12/13/2016
2.9.0 1,344 12/12/2016
2.8.2 1,326 11/28/2016
2.8.1 1,298 11/24/2016
2.8.0 1,339 11/22/2016
2.7.3 1,607 11/8/2016
2.7.2 1,554 11/3/2016
2.7.1 1,535 11/1/2016
2.7.0 1,347 10/31/2016
2.6.3 1,372 10/25/2016
2.6.1 1,310 10/11/2016
2.6.0 1,328 10/10/2016
2.5.4 1,812 9/22/2016
2.5.3 1,680 9/20/2016
2.5.2 1,457 9/19/2016
2.5.1 1,573 9/19/2016
2.5.0 1,359 9/14/2016
2.4.0 1,421 8/29/2016
2.3.1 1,358 8/22/2016
2.3.0 1,469 8/8/2016
2.2.2 1,373 7/22/2016
2.2.1 1,355 7/19/2016
2.2.0 1,352 7/18/2016
2.1.0 1,473 6/27/2016
2.0.2 1,306 6/22/2016
2.0.1 1,350 6/7/2016
2.0.0 1,457 6/6/2016
1.9.4 1,716 5/19/2016
1.9.3 1,326 5/19/2016
1.9.0 1,266 5/16/2016
1.8.4 1,322 5/10/2016
1.8.1 1,321 5/4/2016
1.8.0 1,577 4/25/2016
1.7.2 1,370 4/20/2016
1.7.1 1,332 4/7/2016
1.7.0 1,306 4/6/2016
1.6.1 1,378 3/16/2016
1.5.0 1,415 2/22/2016
1.4.2 1,389 2/3/2016
1.4.1 1,333 2/2/2016
1.4.0 1,357 2/1/2016
1.3.7 1,373 1/21/2016
1.3.5 1,372 1/13/2016
1.3.3 1,496 1/13/2016
1.3.0 1,353 1/11/2016
1.2.2 1,409 12/30/2015
1.2.1 1,334 12/15/2015
1.2.0 1,949 12/14/2015
1.1.0 1,386 12/9/2015
1.0.0 1,614 11/20/2015
0.3.11-alpha-9-gdaed198 1,080 11/16/2015
0.3.0 1,462 11/12/2015
0.0.1-alpha-1523061607 1,128 6/23/2015
0.0.1-alpha-1523061604 1,091 6/23/2015
0.0.1-alpha-1518061325 1,060 6/18/2015
0.0.1-alpha-1518061107 1,020 6/18/2015
0.0.1-alpha-1517061543 1,101 6/17/2015
0.0.1-alpha-1517061409 1,154 6/17/2015