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 263,836 10/24/2025
2.78.3 661,877 2/20/2025
2.78.2 164,612 11/26/2024
2.78.1 21,117 11/19/2024
2.78.0 9,313 11/18/2024
2.77.0 560,368 7/1/2024
2.76.0 356,587 4/7/2024
2.75.3 294,056 2/18/2024
2.75.2 88,308 1/27/2024
2.75.1 114,558 1/13/2024
2.75.0 13,924 1/12/2024
2.74.1 178,701 11/30/2023
2.74.0 95,576 11/20/2023
2.73.2 47,900 11/13/2023
2.73.1 17,269 11/7/2023
2.73.0 12,807 11/2/2023
2.72.1 18,576 10/28/2023
2.72.0 12,095 10/24/2023
2.71.1 8,982 10/18/2023
2.71.0 44,804 9/30/2023
2.70.4 43,146 9/18/2023
2.70.3 47,043 9/5/2023
2.70.2 2,311 9/4/2023
2.70.1 18,993 8/21/2023
2.70.0 52,505 8/2/2023
2.67.5 99,095 6/21/2023
2.67.3 24,606 6/2/2023
2.67.2 7,315 5/26/2023
2.67.1 37,427 5/16/2023
2.67.0 19,547 5/6/2023
2.66.2 37,563 4/26/2023
2.66.1 2,086 4/25/2023
2.66.0 2,396 4/24/2023
2.65.3 13,542 4/14/2023
2.65.2 5,524 4/11/2023
2.65.1 4,157 4/9/2023
2.65.0 2,144 4/7/2023
2.64.0 73,115 3/30/2023
2.63.1 9,733 3/21/2023
2.63.0 1,722 3/20/2023
2.62.2 13,570 3/7/2023
2.62.1 22,414 2/15/2023
2.62.0 1,419 2/14/2023
2.61.0 79,511 1/30/2023
2.60.2 42,695 1/20/2023
2.60.1 8,705 1/18/2023
2.60.0 4,087 1/13/2023
2.60.0-preview.2 941 12/25/2022
2.60.0-preview.1 821 12/20/2022
2.59.4 8,382 9/7/2022
2.59.3 1,722 7/6/2022
2.59.2 1,879 4/11/2022
2.59.1 1,056 3/31/2022
2.59.0 1,662 1/19/2022
2.58.9 1,497 11/4/2021
2.58.8 829 11/1/2021
2.58.5 799 10/26/2021
2.58.4 1,891 9/14/2021
2.58.3 1,055 9/7/2021
2.58.2 1,416 8/24/2021
2.58.1 821 8/23/2021
2.58.0 3,788 6/9/2021
2.57.2 1,959 4/14/2021
2.57.1 894 4/13/2021
2.57.0 985 4/9/2021
2.56.7 3,612 3/2/2021
2.56.6 4,584 12/10/2020
2.56.5 1,725 11/10/2020
2.56.4 1,367 10/20/2020
2.56.3 1,089 10/12/2020
2.56.2 2,692 7/27/2020
2.56.1 1,552 7/6/2020
2.56.0 1,316 6/29/2020
2.55.0 1,557 6/12/2020
2.53.1 2,717 5/11/2020
2.52.0 2,149 4/13/2020
2.51.0 1,952 3/20/2020
2.50.0 2,117 3/2/2020
2.49.0 1,152 2/17/2020
2.48.1 3,271 1/13/2020
2.48.0 2,445 12/9/2019
2.47.0 2,429 10/31/2019
2.46.0 1,736 10/14/2019
2.45.1 2,355 9/15/2019
2.45.0 1,973 8/25/2019
2.44.0 1,953 8/2/2019
2.43.2 2,641 7/2/2019
2.43.1 1,796 6/14/2019
2.42.4 2,700 5/24/2019
2.42.3 13,573 5/13/2019
2.42.2 1,198 5/10/2019
2.42.0 1,505 4/22/2019
2.41.0 2,352 3/29/2019
2.40.11 2,676 2/16/2019
2.40.10 2,245 2/1/2019
2.40.9 1,297 1/31/2019
2.40.8 1,840 1/25/2019
2.40.7 3,040 1/4/2019
2.40.5 1,308 12/19/2018
2.40.4 3,163 11/26/2018
2.40.2 2,247 11/7/2018
2.40.1 1,885 10/29/2018
2.40.0 2,567 10/12/2018
2.39.2 3,817 9/9/2018
2.39.1 1,928 9/4/2018
2.39.0 1,908 9/2/2018
2.38.1 6,835 8/16/2018
2.38.0 2,458 8/13/2018
2.37.2 2,527 7/31/2018
2.37.1 1,845 7/31/2018
2.36.2 2,129 6/13/2018
2.36.1 2,175 5/25/2018
2.36.0 2,189 5/21/2018
2.36.0-alpha-0159-g25e5900b4 1,871 4/26/2018
2.35.4 2,352 5/2/2018
2.35.3 2,219 5/2/2018
2.35.0-alpha-0153-g6da267dd4 1,863 4/25/2018
2.33.2 2,354 4/3/2018
2.33.1 2,204 4/3/2018
2.33.0 2,361 3/19/2018
2.32.2 1,865 3/12/2018
2.32.0 2,285 2/28/2018
2.31.0 2,414 2/5/2018
2.30.0 2,400 1/12/2018
2.29.1 2,241 12/29/2017
2.28.3 1,953 12/14/2017
2.28.2 2,273 12/7/2017
2.28.1 1,904 12/1/2017
2.28.0 1,906 11/30/2017
2.27.0 1,893 11/21/2017
2.26.3 2,016 10/26/2017
2.26.1 1,884 10/24/2017
2.26.0 1,885 10/23/2017
2.25.1 1,909 10/9/2017
2.25.0 1,869 10/9/2017
2.24.0 2,074 9/11/2017
2.23.1 1,993 8/22/2017
2.22.3 1,893 8/17/2017
2.22.1 1,921 8/2/2017
2.22.0 1,948 8/1/2017
2.21.2 1,868 7/26/2017
2.21.1 2,007 7/17/2017
2.20.0 1,986 7/12/2017
2.19.2 1,960 6/29/2017
2.18.5 1,976 6/15/2017
2.18.4 1,923 6/9/2017
2.18.3 1,925 6/8/2017
2.18.1 1,889 5/31/2017
2.17.5 1,933 5/23/2017
2.17.3 1,920 5/11/2017
2.17.2 1,910 5/9/2017
2.16.8 1,947 5/3/2017
2.16.7 1,905 4/26/2017
2.16.5 1,875 4/25/2017
2.16.2 1,919 4/20/2017
2.16.0 1,953 4/17/2017
2.15.5 2,043 4/6/2017
2.15.2 1,947 3/29/2017
2.13.1 1,979 3/7/2017
2.13.0 1,969 3/6/2017
2.12.1 1,976 2/14/2017
2.12.0 1,925 2/13/2017
2.11.3 1,962 2/7/2017
2.11.2 1,943 1/25/2017
2.11.1 1,907 1/24/2017
2.11.0 1,906 1/23/2017
2.10.2 1,933 1/4/2017
2.10.1 1,899 1/4/2017
2.10.0 2,037 1/3/2017
2.9.3 1,929 12/15/2016
2.9.2 1,931 12/14/2016
2.9.1 1,888 12/13/2016
2.9.0 1,984 12/12/2016
2.8.2 1,953 11/28/2016
2.8.1 1,923 11/24/2016
2.8.0 1,994 11/22/2016
2.7.3 2,243 11/8/2016
2.7.2 2,179 11/3/2016
2.7.1 2,182 11/1/2016
2.7.0 1,998 10/31/2016
2.6.3 2,011 10/25/2016
2.6.1 1,931 10/11/2016
2.6.0 1,960 10/10/2016
2.5.4 2,467 9/22/2016
2.5.3 2,306 9/20/2016
2.5.2 2,085 9/19/2016
2.5.1 2,223 9/19/2016
2.5.0 2,005 9/14/2016
2.4.0 1,825 8/29/2016
2.3.1 1,749 8/22/2016
2.3.0 1,886 8/8/2016
2.2.2 1,787 7/22/2016
2.2.1 1,747 7/19/2016
2.2.0 1,771 7/18/2016
2.1.0 1,897 6/27/2016
2.0.2 1,730 6/22/2016
2.0.1 1,728 6/7/2016
2.0.0 1,866 6/6/2016
1.9.4 2,131 5/19/2016
1.9.3 1,716 5/19/2016
1.9.0 1,672 5/16/2016
1.8.4 1,710 5/10/2016
1.8.1 1,717 5/4/2016
1.8.0 1,977 4/25/2016
1.7.2 1,738 4/20/2016
1.7.1 1,746 4/7/2016
1.7.0 1,702 4/6/2016
1.6.1 1,772 3/16/2016
1.5.0 1,821 2/22/2016
1.4.2 1,801 2/3/2016
1.4.1 1,742 2/2/2016
1.4.0 1,746 2/1/2016
1.3.7 1,786 1/21/2016
1.3.5 1,754 1/13/2016
1.3.3 2,044 1/13/2016
1.3.0 1,732 1/11/2016
1.2.2 1,823 12/30/2015
1.2.1 1,730 12/15/2015
1.2.0 2,482 12/14/2015
1.1.0 1,776 12/9/2015
1.0.0 2,016 11/20/2015
0.3.11-alpha-9-gdaed198 1,487 11/16/2015
0.3.0 1,872 11/12/2015
0.0.1-alpha-1523061607 1,534 6/23/2015
0.0.1-alpha-1523061604 1,484 6/23/2015
0.0.1-alpha-1518061325 1,464 6/18/2015
0.0.1-alpha-1518061107 1,410 6/18/2015
0.0.1-alpha-1517061543 1,496 6/17/2015
0.0.1-alpha-1517061409 1,553 6/17/2015