docfx 2.78.2

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

                    
                

            
nuke :add-package docfx --version 2.78.2

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.2 50,821 11/26/2024
2.78.1 15,559 11/19/2024
2.78.0 3,661 11/18/2024
2.77.0 327,274 7/1/2024
2.76.0 266,387 4/7/2024
2.75.3 225,328 2/18/2024
2.75.2 73,175 1/27/2024
2.75.1 98,539 1/13/2024
2.75.0 10,107 1/12/2024
2.74.1 152,687 11/30/2023
2.74.0 56,469 11/20/2023
2.73.2 33,347 11/13/2023
2.73.1 9,890 11/7/2023
2.73.0 9,558 11/2/2023
2.72.1 14,284 10/28/2023
2.72.0 10,842 10/24/2023
2.71.1 8,227 10/18/2023
2.71.0 38,359 9/30/2023
2.70.4 32,539 9/18/2023
2.70.3 41,129 9/5/2023
2.70.2 1,610 9/4/2023
2.70.1 17,413 8/21/2023
2.70.0 44,304 8/2/2023
2.67.5 84,245 6/21/2023
2.67.3 23,212 6/2/2023
2.67.2 6,525 5/26/2023
2.67.1 35,942 5/16/2023
2.67.0 15,508 5/6/2023
2.66.2 31,074 4/26/2023
2.66.1 1,938 4/25/2023
2.66.0 2,209 4/24/2023
2.65.3 13,097 4/14/2023
2.65.2 5,333 4/11/2023
2.65.1 3,165 4/9/2023
2.65.0 1,982 4/7/2023
2.64.0 51,782 3/30/2023
2.63.1 9,473 3/21/2023
2.63.0 1,570 3/20/2023
2.62.2 13,358 3/7/2023
2.62.1 19,768 2/15/2023
2.62.0 1,238 2/14/2023
2.61.0 64,580 1/30/2023
2.60.2 36,032 1/20/2023
2.60.1 6,336 1/18/2023
2.60.0 3,442 1/13/2023
2.60.0-preview.2 845 12/25/2022
2.60.0-preview.1 684 12/20/2022
2.59.4 7,310 9/7/2022
2.59.3 1,382 7/6/2022
2.59.2 1,587 4/11/2022
2.59.1 786 3/31/2022
2.59.0 1,312 1/19/2022
2.58.9 1,169 11/4/2021
2.58.8 542 11/1/2021
2.58.5 533 10/26/2021
2.58.4 1,616 9/14/2021
2.58.3 763 9/7/2021
2.58.2 1,142 8/24/2021
2.58.1 542 8/23/2021
2.58.0 3,477 6/9/2021
2.57.2 1,665 4/14/2021
2.57.1 619 4/13/2021
2.57.0 686 4/9/2021
2.56.7 3,264 3/2/2021
2.56.6 4,261 12/10/2020
2.56.5 1,435 11/10/2020
2.56.4 1,072 10/20/2020
2.56.3 775 10/12/2020
2.56.2 2,400 7/27/2020
2.56.1 1,266 7/6/2020
2.56.0 989 6/29/2020
2.55.0 1,222 6/12/2020
2.53.1 2,380 5/11/2020
2.52.0 1,831 4/13/2020
2.51.0 1,639 3/20/2020
2.50.0 1,773 3/2/2020
2.49.0 849 2/17/2020
2.48.1 2,936 1/13/2020
2.48.0 2,119 12/9/2019
2.47.0 2,126 10/31/2019
2.46.0 1,433 10/14/2019
2.45.1 2,047 9/15/2019
2.45.0 1,656 8/25/2019
2.44.0 1,640 8/2/2019
2.43.2 2,336 7/2/2019
2.43.1 1,485 6/14/2019
2.42.4 2,370 5/24/2019
2.42.3 13,278 5/13/2019
2.42.2 903 5/10/2019
2.42.0 1,200 4/22/2019
2.41.0 2,024 3/29/2019
2.40.11 2,364 2/16/2019
2.40.10 1,918 2/1/2019
2.40.9 992 1/31/2019
2.40.8 1,512 1/25/2019
2.40.7 2,730 1/4/2019
2.40.5 1,001 12/19/2018
2.40.4 2,834 11/26/2018
2.40.2 1,930 11/7/2018
2.40.1 1,566 10/29/2018
2.40.0 2,239 10/12/2018
2.39.2 3,221 9/9/2018
2.39.1 1,323 9/4/2018
2.39.0 1,339 9/2/2018
2.38.1 6,270 8/16/2018
2.38.0 1,863 8/13/2018
2.37.2 1,938 7/31/2018
2.37.1 1,223 7/31/2018
2.36.2 1,513 6/13/2018
2.36.1 1,560 5/25/2018
2.36.0 1,330 5/21/2018
2.36.0-alpha-0159-g25e5900b4 997 4/26/2018
2.35.4 1,482 5/2/2018
2.35.3 1,349 5/2/2018
2.35.0-alpha-0153-g6da267dd4 1,002 4/25/2018
2.33.2 1,488 4/3/2018
2.33.1 1,334 4/3/2018
2.33.0 1,454 3/19/2018
2.32.2 1,267 3/12/2018
2.32.0 1,415 2/28/2018
2.31.0 1,533 2/5/2018
2.30.0 1,517 1/12/2018
2.29.1 1,369 12/29/2017
2.28.3 1,324 12/14/2017
2.28.2 1,384 12/7/2017
2.28.1 1,285 12/1/2017
2.28.0 1,285 11/30/2017
2.27.0 1,295 11/21/2017
2.26.3 1,382 10/26/2017
2.26.1 1,272 10/24/2017
2.26.0 1,261 10/23/2017
2.25.1 1,287 10/9/2017
2.25.0 1,260 10/9/2017
2.24.0 1,462 9/11/2017
2.23.1 1,387 8/22/2017
2.22.3 1,277 8/17/2017
2.22.1 1,293 8/2/2017
2.22.0 1,307 8/1/2017
2.21.2 1,274 7/26/2017
2.21.1 1,377 7/17/2017
2.20.0 1,350 7/12/2017
2.19.2 1,333 6/29/2017
2.18.5 1,359 6/15/2017
2.18.4 1,317 6/9/2017
2.18.3 1,323 6/8/2017
2.18.1 1,277 5/31/2017
2.17.5 1,302 5/23/2017
2.17.3 1,294 5/11/2017
2.17.2 1,291 5/9/2017
2.16.8 1,333 5/3/2017
2.16.7 1,296 4/26/2017
2.16.5 1,271 4/25/2017
2.16.2 1,297 4/20/2017
2.16.0 1,351 4/17/2017
2.15.5 1,417 4/6/2017
2.15.2 1,323 3/29/2017
2.13.1 1,357 3/7/2017
2.13.0 1,344 3/6/2017
2.12.1 1,367 2/14/2017
2.12.0 1,318 2/13/2017
2.11.3 1,354 2/7/2017
2.11.2 1,325 1/25/2017
2.11.1 1,294 1/24/2017
2.11.0 1,290 1/23/2017
2.10.2 1,319 1/4/2017
2.10.1 1,274 1/4/2017
2.10.0 1,387 1/3/2017
2.9.3 1,290 12/15/2016
2.9.2 1,319 12/14/2016
2.9.1 1,270 12/13/2016
2.9.0 1,357 12/12/2016
2.8.2 1,339 11/28/2016
2.8.1 1,309 11/24/2016
2.8.0 1,364 11/22/2016
2.7.3 1,618 11/8/2016
2.7.2 1,568 11/3/2016
2.7.1 1,547 11/1/2016
2.7.0 1,363 10/31/2016
2.6.3 1,384 10/25/2016
2.6.1 1,323 10/11/2016
2.6.0 1,342 10/10/2016
2.5.4 1,827 9/22/2016
2.5.3 1,691 9/20/2016
2.5.2 1,468 9/19/2016
2.5.1 1,584 9/19/2016
2.5.0 1,372 9/14/2016
2.4.0 1,433 8/29/2016
2.3.1 1,371 8/22/2016
2.3.0 1,479 8/8/2016
2.2.2 1,386 7/22/2016
2.2.1 1,366 7/19/2016
2.2.0 1,365 7/18/2016
2.1.0 1,486 6/27/2016
2.0.2 1,317 6/22/2016
2.0.1 1,361 6/7/2016
2.0.0 1,472 6/6/2016
1.9.4 1,729 5/19/2016
1.9.3 1,337 5/19/2016
1.9.0 1,277 5/16/2016
1.8.4 1,333 5/10/2016
1.8.1 1,334 5/4/2016
1.8.0 1,588 4/25/2016
1.7.2 1,381 4/20/2016
1.7.1 1,343 4/7/2016
1.7.0 1,319 4/6/2016
1.6.1 1,391 3/16/2016
1.5.0 1,426 2/22/2016
1.4.2 1,400 2/3/2016
1.4.1 1,344 2/2/2016
1.4.0 1,368 2/1/2016
1.3.7 1,387 1/21/2016
1.3.5 1,384 1/13/2016
1.3.3 1,507 1/13/2016
1.3.0 1,364 1/11/2016
1.2.2 1,419 12/30/2015
1.2.1 1,344 12/15/2015
1.2.0 1,960 12/14/2015
1.1.0 1,399 12/9/2015
1.0.0 1,627 11/20/2015
0.3.11-alpha-9-gdaed198 1,087 11/16/2015
0.3.0 1,474 11/12/2015
0.0.1-alpha-1523061607 1,136 6/23/2015
0.0.1-alpha-1523061604 1,098 6/23/2015
0.0.1-alpha-1518061325 1,070 6/18/2015
0.0.1-alpha-1518061107 1,028 6/18/2015
0.0.1-alpha-1517061543 1,111 6/17/2015
0.0.1-alpha-1517061409 1,162 6/17/2015