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.

[!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.3 89,875 2 months ago
2.78.2 135,584 5 months ago
2.78.1 19,282 5 months ago
2.78.0 6,310 5 months ago
2.77.0 453,482 9 months ago
2.76.0 316,182 4/7/2024
2.75.3 269,476 2/18/2024
2.75.2 81,338 1/27/2024
2.75.1 111,717 1/13/2024
2.75.0 12,503 1/12/2024
2.74.1 170,676 11/30/2023
2.74.0 81,346 11/20/2023
2.73.2 41,854 11/13/2023
2.73.1 14,361 11/7/2023
2.73.0 11,697 11/2/2023
2.72.1 16,517 10/28/2023
2.72.0 11,596 10/24/2023
2.71.1 8,712 10/18/2023
2.71.0 41,274 9/30/2023
2.70.4 38,940 9/18/2023
2.70.3 45,147 9/5/2023
2.70.2 2,069 9/4/2023
2.70.1 18,565 8/21/2023
2.70.0 49,246 8/2/2023
2.67.5 92,146 6/21/2023
2.67.3 23,945 6/2/2023
2.67.2 6,994 5/26/2023
2.67.1 37,029 5/16/2023
2.67.0 16,171 5/6/2023
2.66.2 36,082 4/26/2023
2.66.1 1,971 4/25/2023
2.66.0 2,269 4/24/2023
2.65.3 13,285 4/14/2023
2.65.2 5,367 4/11/2023
2.65.1 3,769 4/9/2023
2.65.0 2,027 4/7/2023
2.64.0 60,025 3/30/2023
2.63.1 9,536 3/21/2023
2.63.0 1,591 3/20/2023
2.62.2 13,414 3/7/2023
2.62.1 20,661 2/15/2023
2.62.0 1,293 2/14/2023
2.61.0 72,036 1/30/2023
2.60.2 38,643 1/20/2023
2.60.1 7,795 1/18/2023
2.60.0 3,599 1/13/2023
2.60.0-preview.2 856 12/25/2022
2.60.0-preview.1 699 12/20/2022
2.59.4 7,571 9/7/2022
2.59.3 1,430 7/6/2022
2.59.2 1,612 4/11/2022
2.59.1 806 3/31/2022
2.59.0 1,354 1/19/2022
2.58.9 1,207 11/4/2021
2.58.8 557 11/1/2021
2.58.5 548 10/26/2021
2.58.4 1,637 9/14/2021
2.58.3 781 9/7/2021
2.58.2 1,159 8/24/2021
2.58.1 561 8/23/2021
2.58.0 3,508 6/9/2021
2.57.2 1,702 4/14/2021
2.57.1 637 4/13/2021
2.57.0 708 4/9/2021
2.56.7 3,298 3/2/2021
2.56.6 4,290 12/10/2020
2.56.5 1,458 11/10/2020
2.56.4 1,099 10/20/2020
2.56.3 798 10/12/2020
2.56.2 2,423 7/27/2020
2.56.1 1,290 7/6/2020
2.56.0 1,023 6/29/2020
2.55.0 1,251 6/12/2020
2.53.1 2,412 5/11/2020
2.52.0 1,855 4/13/2020
2.51.0 1,672 3/20/2020
2.50.0 1,815 3/2/2020
2.49.0 881 2/17/2020
2.48.1 2,967 1/13/2020
2.48.0 2,145 12/9/2019
2.47.0 2,157 10/31/2019
2.46.0 1,460 10/14/2019
2.45.1 2,075 9/15/2019
2.45.0 1,681 8/25/2019
2.44.0 1,669 8/2/2019
2.43.2 2,364 7/2/2019
2.43.1 1,513 6/14/2019
2.42.4 2,405 5/24/2019
2.42.3 13,304 5/13/2019
2.42.2 929 5/10/2019
2.42.0 1,234 4/22/2019
2.41.0 2,053 3/29/2019
2.40.11 2,395 2/16/2019
2.40.10 1,946 2/1/2019
2.40.9 1,020 1/31/2019
2.40.8 1,540 1/25/2019
2.40.7 2,766 1/4/2019
2.40.5 1,035 12/19/2018
2.40.4 2,863 11/26/2018
2.40.2 1,967 11/7/2018
2.40.1 1,605 10/29/2018
2.40.0 2,280 10/12/2018
2.39.2 3,287 9/9/2018
2.39.1 1,395 9/4/2018
2.39.0 1,408 9/2/2018
2.38.1 6,334 8/16/2018
2.38.0 1,934 8/13/2018
2.37.2 2,014 7/31/2018
2.37.1 1,296 7/31/2018
2.36.2 1,588 6/13/2018
2.36.1 1,639 5/25/2018
2.36.0 1,442 5/21/2018
2.36.0-alpha-0159-g25e5900b4 1,121 4/26/2018
2.35.4 1,606 5/2/2018
2.35.3 1,476 5/2/2018
2.35.0-alpha-0153-g6da267dd4 1,124 4/25/2018
2.33.2 1,616 4/3/2018
2.33.1 1,460 4/3/2018
2.33.0 1,581 3/19/2018
2.32.2 1,348 3/12/2018
2.32.0 1,543 2/28/2018
2.31.0 1,661 2/5/2018
2.30.0 1,648 1/12/2018
2.29.1 1,501 12/29/2017
2.28.3 1,411 12/14/2017
2.28.2 1,518 12/7/2017
2.28.1 1,371 12/1/2017
2.28.0 1,370 11/30/2017
2.27.0 1,382 11/21/2017
2.26.3 1,469 10/26/2017
2.26.1 1,362 10/24/2017
2.26.0 1,346 10/23/2017
2.25.1 1,376 10/9/2017
2.25.0 1,348 10/9/2017
2.24.0 1,555 9/11/2017
2.23.1 1,473 8/22/2017
2.22.3 1,361 8/17/2017
2.22.1 1,379 8/2/2017
2.22.0 1,400 8/1/2017
2.21.2 1,359 7/26/2017
2.21.1 1,462 7/17/2017
2.20.0 1,444 7/12/2017
2.19.2 1,423 6/29/2017
2.18.5 1,449 6/15/2017
2.18.4 1,407 6/9/2017
2.18.3 1,409 6/8/2017
2.18.1 1,363 5/31/2017
2.17.5 1,394 5/23/2017
2.17.3 1,383 5/11/2017
2.17.2 1,378 5/9/2017
2.16.8 1,418 5/3/2017
2.16.7 1,383 4/26/2017
2.16.5 1,362 4/25/2017
2.16.2 1,384 4/20/2017
2.16.0 1,442 4/17/2017
2.15.5 1,508 4/6/2017
2.15.2 1,411 3/29/2017
2.13.1 1,445 3/7/2017
2.13.0 1,432 3/6/2017
2.12.1 1,454 2/14/2017
2.12.0 1,407 2/13/2017
2.11.3 1,441 2/7/2017
2.11.2 1,411 1/25/2017
2.11.1 1,380 1/24/2017
2.11.0 1,378 1/23/2017
2.10.2 1,409 1/4/2017
2.10.1 1,364 1/4/2017
2.10.0 1,481 1/3/2017
2.9.3 1,387 12/15/2016
2.9.2 1,409 12/14/2016
2.9.1 1,359 12/13/2016
2.9.0 1,455 12/12/2016
2.8.2 1,425 11/28/2016
2.8.1 1,400 11/24/2016
2.8.0 1,465 11/22/2016
2.7.3 1,709 11/8/2016
2.7.2 1,656 11/3/2016
2.7.1 1,636 11/1/2016
2.7.0 1,462 10/31/2016
2.6.3 1,472 10/25/2016
2.6.1 1,414 10/11/2016
2.6.0 1,430 10/10/2016
2.5.4 1,919 9/22/2016
2.5.3 1,778 9/20/2016
2.5.2 1,557 9/19/2016
2.5.1 1,674 9/19/2016
2.5.0 1,468 9/14/2016
2.4.0 1,527 8/29/2016
2.3.1 1,460 8/22/2016
2.3.0 1,571 8/8/2016
2.2.2 1,476 7/22/2016
2.2.1 1,455 7/19/2016
2.2.0 1,455 7/18/2016
2.1.0 1,579 6/27/2016
2.0.2 1,410 6/22/2016
2.0.1 1,453 6/7/2016
2.0.0 1,563 6/6/2016
1.9.4 1,829 5/19/2016
1.9.3 1,427 5/19/2016
1.9.0 1,365 5/16/2016
1.8.4 1,421 5/10/2016
1.8.1 1,425 5/4/2016
1.8.0 1,677 4/25/2016
1.7.2 1,470 4/20/2016
1.7.1 1,435 4/7/2016
1.7.0 1,410 4/6/2016
1.6.1 1,481 3/16/2016
1.5.0 1,521 2/22/2016
1.4.2 1,490 2/3/2016
1.4.1 1,434 2/2/2016
1.4.0 1,458 2/1/2016
1.3.7 1,477 1/21/2016
1.3.5 1,475 1/13/2016
1.3.3 1,649 1/13/2016
1.3.0 1,457 1/11/2016
1.2.2 1,511 12/30/2015
1.2.1 1,433 12/15/2015
1.2.0 2,056 12/14/2015
1.1.0 1,493 12/9/2015
1.0.0 1,726 11/20/2015
0.3.11-alpha-9-gdaed198 1,177 11/16/2015
0.3.0 1,569 11/12/2015
0.0.1-alpha-1523061607 1,229 6/23/2015
0.0.1-alpha-1523061604 1,192 6/23/2015
0.0.1-alpha-1518061325 1,163 6/18/2015
0.0.1-alpha-1518061107 1,122 6/18/2015
0.0.1-alpha-1517061543 1,221 6/17/2015
0.0.1-alpha-1517061409 1,256 6/17/2015