docfx 2.78.4

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


                    

                
nuke :add-package docfx --version 2.78.4

Build your docs with docfx

NuGet ci nightly Help Wanted Ask DeepWiki

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.

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.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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.4 330,924 10/24/2025
2.78.3 691,702 2/20/2025
2.78.2 166,756 11/26/2024
2.78.1 21,229 11/19/2024
2.78.0 9,597 11/18/2024
2.77.0 569,516 7/1/2024
2.76.0 360,242 4/7/2024
2.75.3 296,759 2/18/2024
2.75.2 90,354 1/27/2024
2.75.1 114,637 1/13/2024
2.75.0 13,968 1/12/2024
2.74.1 179,332 11/30/2023
2.74.0 96,736 11/20/2023
2.73.2 48,494 11/13/2023
2.73.1 17,454 11/7/2023
2.73.0 12,822 11/2/2023
2.72.1 18,755 10/28/2023
2.72.0 12,127 10/24/2023
2.71.1 8,992 10/18/2023
2.71.0 45,884 9/30/2023
2.70.4 43,412 9/18/2023
2.70.3 47,229 9/5/2023
2.70.2 2,326 9/4/2023
2.70.1 19,016 8/21/2023
2.70.0 52,898 8/2/2023
2.67.5 99,685 6/21/2023
2.67.3 24,628 6/2/2023
2.67.2 7,323 5/26/2023
2.67.1 37,437 5/16/2023
2.67.0 19,842 5/6/2023
2.66.2 37,668 4/26/2023
2.66.1 2,090 4/25/2023
2.66.0 2,405 4/24/2023
2.65.3 13,552 4/14/2023
2.65.2 5,543 4/11/2023
2.65.1 4,172 4/9/2023
2.65.0 2,155 4/7/2023
2.64.0 73,751 3/30/2023
2.63.1 9,747 3/21/2023
2.63.0 1,732 3/20/2023
2.62.2 13,579 3/7/2023
2.62.1 22,422 2/15/2023
2.62.0 1,427 2/14/2023
2.61.0 80,014 1/30/2023
2.60.2 43,133 1/20/2023
2.60.1 8,773 1/18/2023
2.60.0 4,104 1/13/2023
2.60.0-preview.2 948 12/25/2022
2.60.0-preview.1 826 12/20/2022
2.59.4 8,454 9/7/2022
2.59.3 1,754 7/6/2022
2.59.2 1,906 4/11/2022
2.59.1 1,093 3/31/2022
2.59.0 1,698 1/19/2022
2.58.9 1,531 11/4/2021
2.58.8 859 11/1/2021
2.58.5 826 10/26/2021
2.58.4 1,923 9/14/2021
2.58.3 1,090 9/7/2021
2.58.2 1,445 8/24/2021
2.58.1 853 8/23/2021
2.58.0 3,821 6/9/2021
2.57.2 1,988 4/14/2021
2.57.1 921 4/13/2021
2.57.0 1,015 4/9/2021
2.56.7 3,641 3/2/2021
2.56.6 4,621 12/10/2020
2.56.5 1,759 11/10/2020
2.56.4 1,399 10/20/2020
2.56.3 1,121 10/12/2020
2.56.2 2,724 7/27/2020
2.56.1 1,586 7/6/2020
2.56.0 1,352 6/29/2020
2.55.0 1,586 6/12/2020
2.53.1 2,755 5/11/2020
2.52.0 2,178 4/13/2020
2.51.0 1,985 3/20/2020
2.50.0 2,154 3/2/2020
2.49.0 1,180 2/17/2020
2.48.1 3,302 1/13/2020
2.48.0 2,475 12/9/2019
2.47.0 2,460 10/31/2019
2.46.0 1,767 10/14/2019
2.45.1 2,385 9/15/2019
2.45.0 2,002 8/25/2019
2.44.0 1,982 8/2/2019
2.43.2 2,673 7/2/2019
2.43.1 1,829 6/14/2019
2.42.4 2,730 5/24/2019
2.42.3 13,605 5/13/2019
2.42.2 1,233 5/10/2019
2.42.0 1,540 4/22/2019
2.41.0 2,385 3/29/2019
2.40.11 2,709 2/16/2019
2.40.10 2,279 2/1/2019
2.40.9 1,333 1/31/2019
2.40.8 1,873 1/25/2019
2.40.7 3,069 1/4/2019
2.40.5 1,343 12/19/2018
2.40.4 3,196 11/26/2018
2.40.2 2,279 11/7/2018
2.40.1 1,915 10/29/2018
2.40.0 2,599 10/12/2018
2.39.2 3,879 9/9/2018
2.39.1 1,987 9/4/2018
2.39.0 1,968 9/2/2018
2.38.1 6,901 8/16/2018
2.38.0 2,516 8/13/2018
2.37.2 2,586 7/31/2018
2.37.1 1,903 7/31/2018
2.36.2 2,191 6/13/2018
2.36.1 2,242 5/25/2018
2.36.0 2,273 5/21/2018
2.36.0-alpha-0159-g25e5900b4 1,960 4/26/2018
2.35.4 2,438 5/2/2018
2.35.3 2,301 5/2/2018
2.35.0-alpha-0153-g6da267dd4 1,949 4/25/2018
2.33.2 2,433 4/3/2018
2.33.1 2,289 4/3/2018
2.33.0 2,452 3/19/2018
2.32.2 1,919 3/12/2018
2.32.0 2,373 2/28/2018
2.31.0 2,497 2/5/2018
2.30.0 2,486 1/12/2018
2.29.1 2,326 12/29/2017
2.28.3 2,010 12/14/2017
2.28.2 2,360 12/7/2017
2.28.1 1,962 12/1/2017
2.28.0 1,964 11/30/2017
2.27.0 1,951 11/21/2017
2.26.3 2,082 10/26/2017
2.26.1 1,943 10/24/2017
2.26.0 1,940 10/23/2017
2.25.1 1,970 10/9/2017
2.25.0 1,928 10/9/2017
2.24.0 2,135 9/11/2017
2.23.1 2,052 8/22/2017
2.22.3 1,948 8/17/2017
2.22.1 1,979 8/2/2017
2.22.0 2,009 8/1/2017
2.21.2 1,931 7/26/2017
2.21.1 2,067 7/17/2017
2.20.0 2,049 7/12/2017
2.19.2 2,024 6/29/2017
2.18.5 2,037 6/15/2017
2.18.4 1,986 6/9/2017
2.18.3 1,987 6/8/2017
2.18.1 1,955 5/31/2017
2.17.5 1,993 5/23/2017
2.17.3 1,983 5/11/2017
2.17.2 1,970 5/9/2017
2.16.8 2,004 5/3/2017
2.16.7 1,965 4/26/2017
2.16.5 1,938 4/25/2017
2.16.2 1,978 4/20/2017
2.16.0 2,011 4/17/2017
2.15.5 2,100 4/6/2017
2.15.2 2,006 3/29/2017
2.13.1 2,041 3/7/2017
2.13.0 2,026 3/6/2017
2.12.1 2,036 2/14/2017
2.12.0 1,988 2/13/2017
2.11.3 2,028 2/7/2017
2.11.2 2,003 1/25/2017
2.11.1 1,966 1/24/2017
2.11.0 1,968 1/23/2017
2.10.2 1,989 1/4/2017
2.10.1 1,957 1/4/2017
2.10.0 2,098 1/3/2017
2.9.3 1,990 12/15/2016
2.9.2 1,991 12/14/2016
2.9.1 1,948 12/13/2016
2.9.0 2,052 12/12/2016
2.8.2 2,011 11/28/2016
2.8.1 1,979 11/24/2016
2.8.0 2,066 11/22/2016
2.7.3 2,307 11/8/2016
2.7.2 2,241 11/3/2016
2.7.1 2,243 11/1/2016
2.7.0 2,056 10/31/2016
2.6.3 2,075 10/25/2016
2.6.1 1,993 10/11/2016
2.6.0 2,018 10/10/2016
2.5.4 2,532 9/22/2016
2.5.3 2,370 9/20/2016
2.5.2 2,146 9/19/2016
2.5.1 2,285 9/19/2016
2.5.0 2,064 9/14/2016
2.4.0 1,836 8/29/2016
2.3.1 1,764 8/22/2016
2.3.0 1,901 8/8/2016
2.2.2 1,799 7/22/2016
2.2.1 1,760 7/19/2016
2.2.0 1,786 7/18/2016
2.1.0 1,911 6/27/2016
2.0.2 1,744 6/22/2016
2.0.1 1,739 6/7/2016
2.0.0 1,883 6/6/2016
1.9.4 2,146 5/19/2016
1.9.3 1,729 5/19/2016
1.9.0 1,687 5/16/2016
1.8.4 1,724 5/10/2016
1.8.1 1,731 5/4/2016
1.8.0 1,987 4/25/2016
1.7.2 1,747 4/20/2016
1.7.1 1,759 4/7/2016
1.7.0 1,717 4/6/2016
1.6.1 1,781 3/16/2016
1.5.0 1,830 2/22/2016
1.4.2 1,814 2/3/2016
1.4.1 1,752 2/2/2016
1.4.0 1,754 2/1/2016
1.3.7 1,796 1/21/2016
1.3.5 1,769 1/13/2016
1.3.3 2,060 1/13/2016
1.3.0 1,742 1/11/2016
1.2.2 1,833 12/30/2015
1.2.1 1,742 12/15/2015
1.2.0 2,498 12/14/2015
1.1.0 1,791 12/9/2015
1.0.0 2,029 11/20/2015
0.3.11-alpha-9-gdaed198 1,500 11/16/2015
0.3.0 1,888 11/12/2015
0.0.1-alpha-1523061607 1,547 6/23/2015
0.0.1-alpha-1523061604 1,495 6/23/2015
0.0.1-alpha-1518061325 1,478 6/18/2015
0.0.1-alpha-1518061107 1,425 6/18/2015
0.0.1-alpha-1517061543 1,511 6/17/2015
0.0.1-alpha-1517061409 1,566 6/17/2015