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.

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.3 410,638 2/20/2025
2.78.2 151,076 11/26/2024
2.78.1 20,585 11/19/2024
2.78.0 7,781 11/18/2024
2.77.0 517,265 7/1/2024
2.76.0 339,176 4/7/2024
2.75.3 285,244 2/18/2024
2.75.2 84,487 1/27/2024
2.75.1 113,978 1/13/2024
2.75.0 13,721 1/12/2024
2.74.1 175,723 11/30/2023
2.74.0 89,268 11/20/2023
2.73.2 45,717 11/13/2023
2.73.1 16,328 11/7/2023
2.73.0 12,744 11/2/2023
2.72.1 17,744 10/28/2023
2.72.0 11,973 10/24/2023
2.71.1 8,916 10/18/2023
2.71.0 43,682 9/30/2023
2.70.4 41,175 9/18/2023
2.70.3 46,481 9/5/2023
2.70.2 2,263 9/4/2023
2.70.1 18,878 8/21/2023
2.70.0 51,554 8/2/2023
2.67.5 96,854 6/21/2023
2.67.3 24,477 6/2/2023
2.67.2 7,248 5/26/2023
2.67.1 37,351 5/16/2023
2.67.0 17,848 5/6/2023
2.66.2 37,069 4/26/2023
2.66.1 2,021 4/25/2023
2.66.0 2,328 4/24/2023
2.65.3 13,435 4/14/2023
2.65.2 5,425 4/11/2023
2.65.1 3,995 4/9/2023
2.65.0 2,081 4/7/2023
2.64.0 66,458 3/30/2023
2.63.1 9,627 3/21/2023
2.63.0 1,643 3/20/2023
2.62.2 13,505 3/7/2023
2.62.1 21,604 2/15/2023
2.62.0 1,348 2/14/2023
2.61.0 76,520 1/30/2023
2.60.2 40,470 1/20/2023
2.60.1 8,419 1/18/2023
2.60.0 3,946 1/13/2023
2.60.0-preview.2 907 12/25/2022
2.60.0-preview.1 755 12/20/2022
2.59.4 7,944 9/7/2022
2.59.3 1,528 7/6/2022
2.59.2 1,705 4/11/2022
2.59.1 887 3/31/2022
2.59.0 1,463 1/19/2022
2.58.9 1,304 11/4/2021
2.58.8 649 11/1/2021
2.58.5 631 10/26/2021
2.58.4 1,721 9/14/2021
2.58.3 868 9/7/2021
2.58.2 1,244 8/24/2021
2.58.1 657 8/23/2021
2.58.0 3,605 6/9/2021
2.57.2 1,790 4/14/2021
2.57.1 724 4/13/2021
2.57.0 802 4/9/2021
2.56.7 3,405 3/2/2021
2.56.6 4,397 12/10/2020
2.56.5 1,551 11/10/2020
2.56.4 1,192 10/20/2020
2.56.3 894 10/12/2020
2.56.2 2,516 7/27/2020
2.56.1 1,379 7/6/2020
2.56.0 1,124 6/29/2020
2.55.0 1,352 6/12/2020
2.53.1 2,526 5/11/2020
2.52.0 1,955 4/13/2020
2.51.0 1,771 3/20/2020
2.50.0 1,925 3/2/2020
2.49.0 977 2/17/2020
2.48.1 3,078 1/13/2020
2.48.0 2,249 12/9/2019
2.47.0 2,260 10/31/2019
2.46.0 1,557 10/14/2019
2.45.1 2,175 9/15/2019
2.45.0 1,786 8/25/2019
2.44.0 1,768 8/2/2019
2.43.2 2,462 7/2/2019
2.43.1 1,617 6/14/2019
2.42.4 2,508 5/24/2019
2.42.3 13,402 5/13/2019
2.42.2 1,027 5/10/2019
2.42.0 1,327 4/22/2019
2.41.0 2,156 3/29/2019
2.40.11 2,491 2/16/2019
2.40.10 2,053 2/1/2019
2.40.9 1,118 1/31/2019
2.40.8 1,647 1/25/2019
2.40.7 2,864 1/4/2019
2.40.5 1,132 12/19/2018
2.40.4 2,973 11/26/2018
2.40.2 2,074 11/7/2018
2.40.1 1,711 10/29/2018
2.40.0 2,388 10/12/2018
2.39.2 3,485 9/9/2018
2.39.1 1,592 9/4/2018
2.39.0 1,603 9/2/2018
2.38.1 6,524 8/16/2018
2.38.0 2,128 8/13/2018
2.37.2 2,213 7/31/2018
2.37.1 1,506 7/31/2018
2.36.2 1,798 6/13/2018
2.36.1 1,847 5/25/2018
2.36.0 1,733 5/21/2018
2.36.0-alpha-0159-g25e5900b4 1,413 4/26/2018
2.35.4 1,895 5/2/2018
2.35.3 1,767 5/2/2018
2.35.0-alpha-0153-g6da267dd4 1,412 4/25/2018
2.33.2 1,907 4/3/2018
2.33.1 1,751 4/3/2018
2.33.0 1,879 3/19/2018
2.32.2 1,551 3/12/2018
2.32.0 1,833 2/28/2018
2.31.0 1,954 2/5/2018
2.30.0 1,941 1/12/2018
2.29.1 1,794 12/29/2017
2.28.3 1,617 12/14/2017
2.28.2 1,813 12/7/2017
2.28.1 1,580 12/1/2017
2.28.0 1,578 11/30/2017
2.27.0 1,583 11/21/2017
2.26.3 1,679 10/26/2017
2.26.1 1,566 10/24/2017
2.26.0 1,553 10/23/2017
2.25.1 1,578 10/9/2017
2.25.0 1,546 10/9/2017
2.24.0 1,759 9/11/2017
2.23.1 1,674 8/22/2017
2.22.3 1,566 8/17/2017
2.22.1 1,585 8/2/2017
2.22.0 1,613 8/1/2017
2.21.2 1,558 7/26/2017
2.21.1 1,675 7/17/2017
2.20.0 1,657 7/12/2017
2.19.2 1,633 6/29/2017
2.18.5 1,650 6/15/2017
2.18.4 1,608 6/9/2017
2.18.3 1,611 6/8/2017
2.18.1 1,566 5/31/2017
2.17.5 1,601 5/23/2017
2.17.3 1,592 5/11/2017
2.17.2 1,581 5/9/2017
2.16.8 1,625 5/3/2017
2.16.7 1,584 4/26/2017
2.16.5 1,561 4/25/2017
2.16.2 1,589 4/20/2017
2.16.0 1,640 4/17/2017
2.15.5 1,718 4/6/2017
2.15.2 1,617 3/29/2017
2.13.1 1,655 3/7/2017
2.13.0 1,634 3/6/2017
2.12.1 1,656 2/14/2017
2.12.0 1,610 2/13/2017
2.11.3 1,646 2/7/2017
2.11.2 1,618 1/25/2017
2.11.1 1,585 1/24/2017
2.11.0 1,581 1/23/2017
2.10.2 1,614 1/4/2017
2.10.1 1,572 1/4/2017
2.10.0 1,699 1/3/2017
2.9.3 1,598 12/15/2016
2.9.2 1,616 12/14/2016
2.9.1 1,568 12/13/2016
2.9.0 1,663 12/12/2016
2.8.2 1,631 11/28/2016
2.8.1 1,604 11/24/2016
2.8.0 1,688 11/22/2016
2.7.3 1,918 11/8/2016
2.7.2 1,861 11/3/2016
2.7.1 1,843 11/1/2016
2.7.0 1,679 10/31/2016
2.6.3 1,689 10/25/2016
2.6.1 1,619 10/11/2016
2.6.0 1,641 10/10/2016
2.5.4 2,129 9/22/2016
2.5.3 1,979 9/20/2016
2.5.2 1,762 9/19/2016
2.5.1 1,891 9/19/2016
2.5.0 1,682 9/14/2016
2.4.0 1,690 8/29/2016
2.3.1 1,626 8/22/2016
2.3.0 1,736 8/8/2016
2.2.2 1,643 7/22/2016
2.2.1 1,612 7/19/2016
2.2.0 1,617 7/18/2016
2.1.0 1,748 6/27/2016
2.0.2 1,579 6/22/2016
2.0.1 1,610 6/7/2016
2.0.0 1,728 6/6/2016
1.9.4 1,994 5/19/2016
1.9.3 1,587 5/19/2016
1.9.0 1,529 5/16/2016
1.8.4 1,580 5/10/2016
1.8.1 1,585 5/4/2016
1.8.0 1,834 4/25/2016
1.7.2 1,625 4/20/2016
1.7.1 1,595 4/7/2016
1.7.0 1,570 4/6/2016
1.6.1 1,642 3/16/2016
1.5.0 1,683 2/22/2016
1.4.2 1,653 2/3/2016
1.4.1 1,599 2/2/2016
1.4.0 1,617 2/1/2016
1.3.7 1,633 1/21/2016
1.3.5 1,632 1/13/2016
1.3.3 1,884 1/13/2016
1.3.0 1,614 1/11/2016
1.2.2 1,678 12/30/2015
1.2.1 1,602 12/15/2015
1.2.0 2,225 12/14/2015
1.1.0 1,654 12/9/2015
1.0.0 1,885 11/20/2015
0.3.11-alpha-9-gdaed198 1,341 11/16/2015
0.3.0 1,735 11/12/2015
0.0.1-alpha-1523061607 1,385 6/23/2015
0.0.1-alpha-1523061604 1,352 6/23/2015
0.0.1-alpha-1518061325 1,319 6/18/2015
0.0.1-alpha-1518061107 1,275 6/18/2015
0.0.1-alpha-1517061543 1,378 6/17/2015
0.0.1-alpha-1517061409 1,416 6/17/2015