docfx 2.78.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.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.78.0
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.0
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=docfx&version=2.78.0                

                    
                

            
nuke :add-package docfx --version 2.78.0

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. 
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.1 5,988 11/19/2024
2.78.0 2,605 11/18/2024
2.77.0 291,295 7/1/2024
2.76.0 249,150 4/7/2024
2.75.3 204,099 2/18/2024
2.75.2 69,819 1/27/2024
2.75.1 91,131 1/13/2024
2.75.0 9,389 1/12/2024
2.74.1 143,923 11/30/2023
2.74.0 50,287 11/20/2023
2.73.2 30,338 11/13/2023
2.73.1 9,041 11/7/2023
2.73.0 9,481 11/2/2023
2.72.1 13,061 10/28/2023
2.72.0 10,614 10/24/2023
2.71.1 8,199 10/18/2023
2.71.0 37,337 9/30/2023
2.70.4 30,014 9/18/2023
2.70.3 38,699 9/5/2023
2.70.2 1,589 9/4/2023
2.70.1 16,974 8/21/2023
2.70.0 42,713 8/2/2023
2.67.5 81,585 6/21/2023
2.67.3 23,092 6/2/2023
2.67.2 6,420 5/26/2023
2.67.1 35,405 5/16/2023
2.67.0 15,422 5/6/2023
2.66.2 28,182 4/26/2023
2.66.1 1,898 4/25/2023
2.66.0 2,182 4/24/2023
2.65.3 12,871 4/14/2023
2.65.2 5,304 4/11/2023
2.65.1 2,923 4/9/2023
2.65.0 1,966 4/7/2023
2.64.0 48,628 3/30/2023
2.63.1 9,425 3/21/2023
2.63.0 1,546 3/20/2023
2.62.2 13,297 3/7/2023
2.62.1 19,122 2/15/2023
2.62.0 1,214 2/14/2023
2.61.0 62,115 1/30/2023
2.60.2 35,017 1/20/2023
2.60.1 5,660 1/18/2023
2.60.0 3,366 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,172 9/7/2022
2.59.3 1,345 7/6/2022
2.59.2 1,576 4/11/2022
2.59.1 776 3/31/2022
2.59.0 1,298 1/19/2022
2.58.9 1,151 11/4/2021
2.58.8 534 11/1/2021
2.58.5 521 10/26/2021
2.58.4 1,608 9/14/2021
2.58.3 755 9/7/2021
2.58.2 1,134 8/24/2021
2.58.1 532 8/23/2021
2.58.0 3,457 6/9/2021
2.57.2 1,655 4/14/2021
2.57.1 610 4/13/2021
2.57.0 673 4/9/2021
2.56.7 3,251 3/2/2021
2.56.6 4,246 12/10/2020
2.56.5 1,418 11/10/2020
2.56.4 1,062 10/20/2020
2.56.3 765 10/12/2020
2.56.2 2,385 7/27/2020
2.56.1 1,254 7/6/2020
2.56.0 974 6/29/2020
2.55.0 1,210 6/12/2020
2.53.1 2,360 5/11/2020
2.52.0 1,820 4/13/2020
2.51.0 1,630 3/20/2020
2.50.0 1,755 3/2/2020
2.49.0 842 2/17/2020
2.48.1 2,925 1/13/2020
2.48.0 2,107 12/9/2019
2.47.0 2,118 10/31/2019
2.46.0 1,424 10/14/2019
2.45.1 2,038 9/15/2019
2.45.0 1,643 8/25/2019
2.44.0 1,629 8/2/2019
2.43.2 2,326 7/2/2019
2.43.1 1,475 6/14/2019
2.42.4 2,362 5/24/2019
2.42.3 13,265 5/13/2019
2.42.2 892 5/10/2019
2.42.0 1,193 4/22/2019
2.41.0 2,014 3/29/2019
2.40.11 2,354 2/16/2019
2.40.10 1,908 2/1/2019
2.40.9 984 1/31/2019
2.40.8 1,503 1/25/2019
2.40.7 2,720 1/4/2019
2.40.5 993 12/19/2018
2.40.4 2,822 11/26/2018
2.40.2 1,918 11/7/2018
2.40.1 1,552 10/29/2018
2.40.0 2,223 10/12/2018
2.39.2 3,208 9/9/2018
2.39.1 1,312 9/4/2018
2.39.0 1,328 9/2/2018
2.38.1 6,258 8/16/2018
2.38.0 1,853 8/13/2018
2.37.2 1,923 7/31/2018
2.37.1 1,207 7/31/2018
2.36.2 1,497 6/13/2018
2.36.1 1,545 5/25/2018
2.36.0 1,314 5/21/2018
2.36.0-alpha-0159-g25e5900b4 988 4/26/2018
2.35.4 1,467 5/2/2018
2.35.3 1,333 5/2/2018
2.35.0-alpha-0153-g6da267dd4 992 4/25/2018
2.33.2 1,474 4/3/2018
2.33.1 1,320 4/3/2018
2.33.0 1,439 3/19/2018
2.32.2 1,251 3/12/2018
2.32.0 1,401 2/28/2018
2.31.0 1,515 2/5/2018
2.30.0 1,498 1/12/2018
2.29.1 1,353 12/29/2017
2.28.3 1,308 12/14/2017
2.28.2 1,370 12/7/2017
2.28.1 1,269 12/1/2017
2.28.0 1,269 11/30/2017
2.27.0 1,281 11/21/2017
2.26.3 1,366 10/26/2017
2.26.1 1,252 10/24/2017
2.26.0 1,245 10/23/2017
2.25.1 1,272 10/9/2017
2.25.0 1,246 10/9/2017
2.24.0 1,446 9/11/2017
2.23.1 1,372 8/22/2017
2.22.3 1,261 8/17/2017
2.22.1 1,278 8/2/2017
2.22.0 1,294 8/1/2017
2.21.2 1,258 7/26/2017
2.21.1 1,361 7/17/2017
2.20.0 1,332 7/12/2017
2.19.2 1,314 6/29/2017
2.18.5 1,346 6/15/2017
2.18.4 1,301 6/9/2017
2.18.3 1,307 6/8/2017
2.18.1 1,259 5/31/2017
2.17.5 1,289 5/23/2017
2.17.3 1,281 5/11/2017
2.17.2 1,277 5/9/2017
2.16.8 1,317 5/3/2017
2.16.7 1,280 4/26/2017
2.16.5 1,257 4/25/2017
2.16.2 1,283 4/20/2017
2.16.0 1,335 4/17/2017
2.15.5 1,401 4/6/2017
2.15.2 1,308 3/29/2017
2.13.1 1,342 3/7/2017
2.13.0 1,331 3/6/2017
2.12.1 1,354 2/14/2017
2.12.0 1,305 2/13/2017
2.11.3 1,340 2/7/2017
2.11.2 1,310 1/25/2017
2.11.1 1,279 1/24/2017
2.11.0 1,273 1/23/2017
2.10.2 1,304 1/4/2017
2.10.1 1,261 1/4/2017
2.10.0 1,368 1/3/2017
2.9.3 1,275 12/15/2016
2.9.2 1,305 12/14/2016
2.9.1 1,257 12/13/2016
2.9.0 1,341 12/12/2016
2.8.2 1,324 11/28/2016
2.8.1 1,296 11/24/2016
2.8.0 1,336 11/22/2016
2.7.3 1,605 11/8/2016
2.7.2 1,552 11/3/2016
2.7.1 1,533 11/1/2016
2.7.0 1,343 10/31/2016
2.6.3 1,370 10/25/2016
2.6.1 1,308 10/11/2016
2.6.0 1,326 10/10/2016
2.5.4 1,808 9/22/2016
2.5.3 1,678 9/20/2016
2.5.2 1,455 9/19/2016
2.5.1 1,571 9/19/2016
2.5.0 1,357 9/14/2016
2.4.0 1,418 8/29/2016
2.3.1 1,354 8/22/2016
2.3.0 1,467 8/8/2016
2.2.2 1,370 7/22/2016
2.2.1 1,353 7/19/2016
2.2.0 1,350 7/18/2016
2.1.0 1,470 6/27/2016
2.0.2 1,304 6/22/2016
2.0.1 1,348 6/7/2016
2.0.0 1,452 6/6/2016
1.9.4 1,712 5/19/2016
1.9.3 1,324 5/19/2016
1.9.0 1,264 5/16/2016
1.8.4 1,320 5/10/2016
1.8.1 1,319 5/4/2016
1.8.0 1,575 4/25/2016
1.7.2 1,368 4/20/2016
1.7.1 1,328 4/7/2016
1.7.0 1,304 4/6/2016
1.6.1 1,376 3/16/2016
1.5.0 1,413 2/22/2016
1.4.2 1,387 2/3/2016
1.4.1 1,331 2/2/2016
1.4.0 1,355 2/1/2016
1.3.7 1,371 1/21/2016
1.3.5 1,370 1/13/2016
1.3.3 1,494 1/13/2016
1.3.0 1,349 1/11/2016
1.2.2 1,407 12/30/2015
1.2.1 1,332 12/15/2015
1.2.0 1,947 12/14/2015
1.1.0 1,384 12/9/2015
1.0.0 1,610 11/20/2015
0.3.11-alpha-9-gdaed198 1,080 11/16/2015
0.3.0 1,460 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