docfx 2.78.3

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet tool install --global docfx --version 2.78.3
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.78.3
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=docfx&version=2.78.3
                    


                    

                
nuke :add-package docfx --version 2.78.3

Build your docs with docfx

NuGet ci nightly 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 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.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.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.3 97,624 2/20/2025
2.78.2 136,460 11/26/2024
2.78.1 19,471 11/19/2024
2.78.0 6,391 11/18/2024
2.77.0 459,686 7/1/2024
2.76.0 318,379 4/7/2024
2.75.3 271,933 2/18/2024
2.75.2 81,662 1/27/2024
2.75.1 112,070 1/13/2024
2.75.0 12,719 1/12/2024
2.74.1 171,999 11/30/2023
2.74.0 82,407 11/20/2023
2.73.2 42,314 11/13/2023
2.73.1 14,813 11/7/2023
2.73.0 11,952 11/2/2023
2.72.1 16,623 10/28/2023
2.72.0 11,676 10/24/2023
2.71.1 8,757 10/18/2023
2.71.0 41,422 9/30/2023
2.70.4 39,173 9/18/2023
2.70.3 45,297 9/5/2023
2.70.2 2,118 9/4/2023
2.70.1 18,628 8/21/2023
2.70.0 49,488 8/2/2023
2.67.5 92,776 6/21/2023
2.67.3 24,022 6/2/2023
2.67.2 7,093 5/26/2023
2.67.1 37,138 5/16/2023
2.67.0 16,341 5/6/2023
2.66.2 36,181 4/26/2023
2.66.1 1,972 4/25/2023
2.66.0 2,270 4/24/2023
2.65.3 13,313 4/14/2023
2.65.2 5,368 4/11/2023
2.65.1 3,773 4/9/2023
2.65.0 2,028 4/7/2023
2.64.0 60,451 3/30/2023
2.63.1 9,539 3/21/2023
2.63.0 1,592 3/20/2023
2.62.2 13,415 3/7/2023
2.62.1 20,681 2/15/2023
2.62.0 1,294 2/14/2023
2.61.0 72,365 1/30/2023
2.60.2 38,839 1/20/2023
2.60.1 7,896 1/18/2023
2.60.0 3,627 1/13/2023
2.60.0-preview.2 857 12/25/2022
2.60.0-preview.1 700 12/20/2022
2.59.4 7,621 9/7/2022
2.59.3 1,431 7/6/2022
2.59.2 1,613 4/11/2022
2.59.1 807 3/31/2022
2.59.0 1,357 1/19/2022
2.58.9 1,209 11/4/2021
2.58.8 558 11/1/2021
2.58.5 549 10/26/2021
2.58.4 1,638 9/14/2021
2.58.3 782 9/7/2021
2.58.2 1,160 8/24/2021
2.58.1 562 8/23/2021
2.58.0 3,509 6/9/2021
2.57.2 1,704 4/14/2021
2.57.1 639 4/13/2021
2.57.0 710 4/9/2021
2.56.7 3,303 3/2/2021
2.56.6 4,294 12/10/2020
2.56.5 1,460 11/10/2020
2.56.4 1,101 10/20/2020
2.56.3 800 10/12/2020
2.56.2 2,425 7/27/2020
2.56.1 1,292 7/6/2020
2.56.0 1,025 6/29/2020
2.55.0 1,253 6/12/2020
2.53.1 2,414 5/11/2020
2.52.0 1,857 4/13/2020
2.51.0 1,674 3/20/2020
2.50.0 1,817 3/2/2020
2.49.0 883 2/17/2020
2.48.1 2,969 1/13/2020
2.48.0 2,147 12/9/2019
2.47.0 2,159 10/31/2019
2.46.0 1,462 10/14/2019
2.45.1 2,077 9/15/2019
2.45.0 1,683 8/25/2019
2.44.0 1,670 8/2/2019
2.43.2 2,365 7/2/2019
2.43.1 1,514 6/14/2019
2.42.4 2,407 5/24/2019
2.42.3 13,308 5/13/2019
2.42.2 931 5/10/2019
2.42.0 1,236 4/22/2019
2.41.0 2,055 3/29/2019
2.40.11 2,397 2/16/2019
2.40.10 1,948 2/1/2019
2.40.9 1,022 1/31/2019
2.40.8 1,542 1/25/2019
2.40.7 2,768 1/4/2019
2.40.5 1,037 12/19/2018
2.40.4 2,865 11/26/2018
2.40.2 1,969 11/7/2018
2.40.1 1,607 10/29/2018
2.40.0 2,282 10/12/2018
2.39.2 3,291 9/9/2018
2.39.1 1,399 9/4/2018
2.39.0 1,412 9/2/2018
2.38.1 6,338 8/16/2018
2.38.0 1,938 8/13/2018
2.37.2 2,018 7/31/2018
2.37.1 1,300 7/31/2018
2.36.2 1,594 6/13/2018
2.36.1 1,643 5/25/2018
2.36.0 1,448 5/21/2018
2.36.0-alpha-0159-g25e5900b4 1,123 4/26/2018
2.35.4 1,608 5/2/2018
2.35.3 1,478 5/2/2018
2.35.0-alpha-0153-g6da267dd4 1,126 4/25/2018
2.33.2 1,618 4/3/2018
2.33.1 1,462 4/3/2018
2.33.0 1,583 3/19/2018
2.32.2 1,352 3/12/2018
2.32.0 1,545 2/28/2018
2.31.0 1,663 2/5/2018
2.30.0 1,650 1/12/2018
2.29.1 1,503 12/29/2017
2.28.3 1,413 12/14/2017
2.28.2 1,520 12/7/2017
2.28.1 1,373 12/1/2017
2.28.0 1,372 11/30/2017
2.27.0 1,384 11/21/2017
2.26.3 1,471 10/26/2017
2.26.1 1,364 10/24/2017
2.26.0 1,348 10/23/2017
2.25.1 1,378 10/9/2017
2.25.0 1,350 10/9/2017
2.24.0 1,557 9/11/2017
2.23.1 1,477 8/22/2017
2.22.3 1,363 8/17/2017
2.22.1 1,381 8/2/2017
2.22.0 1,402 8/1/2017
2.21.2 1,361 7/26/2017
2.21.1 1,464 7/17/2017
2.20.0 1,446 7/12/2017
2.19.2 1,425 6/29/2017
2.18.5 1,451 6/15/2017
2.18.4 1,409 6/9/2017
2.18.3 1,411 6/8/2017
2.18.1 1,365 5/31/2017
2.17.5 1,396 5/23/2017
2.17.3 1,385 5/11/2017
2.17.2 1,380 5/9/2017
2.16.8 1,420 5/3/2017
2.16.7 1,385 4/26/2017
2.16.5 1,364 4/25/2017
2.16.2 1,386 4/20/2017
2.16.0 1,444 4/17/2017
2.15.5 1,510 4/6/2017
2.15.2 1,413 3/29/2017
2.13.1 1,447 3/7/2017
2.13.0 1,434 3/6/2017
2.12.1 1,456 2/14/2017
2.12.0 1,409 2/13/2017
2.11.3 1,443 2/7/2017
2.11.2 1,413 1/25/2017
2.11.1 1,382 1/24/2017
2.11.0 1,380 1/23/2017
2.10.2 1,411 1/4/2017
2.10.1 1,366 1/4/2017
2.10.0 1,483 1/3/2017
2.9.3 1,389 12/15/2016
2.9.2 1,411 12/14/2016
2.9.1 1,361 12/13/2016
2.9.0 1,457 12/12/2016
2.8.2 1,427 11/28/2016
2.8.1 1,402 11/24/2016
2.8.0 1,468 11/22/2016
2.7.3 1,711 11/8/2016
2.7.2 1,658 11/3/2016
2.7.1 1,638 11/1/2016
2.7.0 1,464 10/31/2016
2.6.3 1,474 10/25/2016
2.6.1 1,416 10/11/2016
2.6.0 1,432 10/10/2016
2.5.4 1,921 9/22/2016
2.5.3 1,780 9/20/2016
2.5.2 1,559 9/19/2016
2.5.1 1,676 9/19/2016
2.5.0 1,470 9/14/2016
2.4.0 1,529 8/29/2016
2.3.1 1,462 8/22/2016
2.3.0 1,573 8/8/2016
2.2.2 1,478 7/22/2016
2.2.1 1,457 7/19/2016
2.2.0 1,457 7/18/2016
2.1.0 1,581 6/27/2016
2.0.2 1,412 6/22/2016
2.0.1 1,455 6/7/2016
2.0.0 1,565 6/6/2016
1.9.4 1,831 5/19/2016
1.9.3 1,429 5/19/2016
1.9.0 1,367 5/16/2016
1.8.4 1,423 5/10/2016
1.8.1 1,427 5/4/2016
1.8.0 1,679 4/25/2016
1.7.2 1,472 4/20/2016
1.7.1 1,437 4/7/2016
1.7.0 1,412 4/6/2016
1.6.1 1,483 3/16/2016
1.5.0 1,523 2/22/2016
1.4.2 1,492 2/3/2016
1.4.1 1,436 2/2/2016
1.4.0 1,460 2/1/2016
1.3.7 1,479 1/21/2016
1.3.5 1,477 1/13/2016
1.3.3 1,651 1/13/2016
1.3.0 1,459 1/11/2016
1.2.2 1,513 12/30/2015
1.2.1 1,435 12/15/2015
1.2.0 2,058 12/14/2015
1.1.0 1,495 12/9/2015
1.0.0 1,728 11/20/2015
0.3.11-alpha-9-gdaed198 1,179 11/16/2015
0.3.0 1,571 11/12/2015
0.0.1-alpha-1523061607 1,231 6/23/2015
0.0.1-alpha-1523061604 1,194 6/23/2015
0.0.1-alpha-1518061325 1,165 6/18/2015
0.0.1-alpha-1518061107 1,124 6/18/2015
0.0.1-alpha-1517061543 1,223 6/17/2015
0.0.1-alpha-1517061409 1,258 6/17/2015