docfx 2.62.1

Prefix Reserved
.NET 6.0 This package targets .NET 6.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.62.1
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.62.1
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=docfx&version=2.62.1                

                    
                

            
nuke :add-package docfx --version 2.62.1

Build your docs with docfx

NuGet Help Wanted Gitter

Build your technical documentation site with docfx, with landing pages, markdown, API reference docs for .NET, REST API and more.

⚠️⚠️⚠️ NOTICE ⚠️⚠️⚠️

Getting Started

  1. Install docfx as a global tool:

    dotnet tool install -g docfx

  2. Create and start a website locally:

    docfx init -q
docfx docfx_project\docfx.json --serve

  3. Go to https://localhost:8080 to see the sample site.

For more information, refer to Getting Started.

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.

Branch and Release

The main branch is the default branch for pull requests and most other development activities. We occationally use feature/* branches for epic feature development.

Releases are based on a stable main branch commit using GitHub Releases. Release versioning follows Semantic Versioning. 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.

.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.

License

This project is licensed under the MIT License.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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 was computed.  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 20,966 12 days ago
2.78.2 126,370 3 months ago
2.78.1 18,033 3 months ago
2.78.0 5,300 3 months ago
2.77.0 403,012 8 months ago
2.76.0 298,967 4/7/2024
2.75.3 255,524 2/18/2024
2.75.2 78,554 1/27/2024
2.75.1 107,149 1/13/2024
2.75.0 11,416 1/12/2024
2.74.1 164,317 11/30/2023
2.74.0 70,517 11/20/2023
2.73.2 38,593 11/13/2023
2.73.1 12,672 11/7/2023
2.73.0 10,668 11/2/2023
2.72.1 15,692 10/28/2023
2.72.0 11,234 10/24/2023
2.71.1 8,461 10/18/2023
2.71.0 39,971 9/30/2023
2.70.4 36,499 9/18/2023
2.70.3 43,875 9/5/2023
2.70.2 1,825 9/4/2023
2.70.1 18,156 8/21/2023
2.70.0 47,470 8/2/2023
2.67.5 89,349 6/21/2023
2.67.3 23,650 6/2/2023
2.67.2 6,759 5/26/2023
2.67.1 36,710 5/16/2023
2.67.0 15,571 5/6/2023
2.66.2 34,298 4/26/2023
2.66.1 1,957 4/25/2023
2.66.0 2,253 4/24/2023
2.65.3 13,199 4/14/2023
2.65.2 5,361 4/11/2023
2.65.1 3,557 4/9/2023
2.65.0 2,012 4/7/2023
2.64.0 57,453 3/30/2023
2.63.1 9,512 3/21/2023
2.63.0 1,581 3/20/2023
2.62.2 13,394 3/7/2023
2.62.1 20,318 2/15/2023
2.62.0 1,279 2/14/2023
2.61.0 69,319 1/30/2023
2.60.2 37,384 1/20/2023
2.60.1 7,325 1/18/2023
2.60.0 3,547 1/13/2023
2.60.0-preview.2 852 12/25/2022
2.60.0-preview.1 695 12/20/2022
2.59.4 7,423 9/7/2022
2.59.3 1,412 7/6/2022
2.59.2 1,593 4/11/2022
2.59.1 791 3/31/2022
2.59.0 1,332 1/19/2022
2.58.9 1,186 11/4/2021
2.58.8 547 11/1/2021
2.58.5 538 10/26/2021
2.58.4 1,625 9/14/2021
2.58.3 770 9/7/2021
2.58.2 1,149 8/24/2021
2.58.1 547 8/23/2021
2.58.0 3,494 6/9/2021
2.57.2 1,686 4/14/2021
2.57.1 626 4/13/2021
2.57.0 693 4/9/2021
2.56.7 3,274 3/2/2021
2.56.6 4,271 12/10/2020
2.56.5 1,442 11/10/2020
2.56.4 1,082 10/20/2020
2.56.3 782 10/12/2020
2.56.2 2,407 7/27/2020
2.56.1 1,273 7/6/2020
2.56.0 1,004 6/29/2020
2.55.0 1,234 6/12/2020
2.53.1 2,388 5/11/2020
2.52.0 1,837 4/13/2020
2.51.0 1,649 3/20/2020
2.50.0 1,792 3/2/2020
2.49.0 862 2/17/2020
2.48.1 2,946 1/13/2020
2.48.0 2,127 12/9/2019
2.47.0 2,137 10/31/2019
2.46.0 1,441 10/14/2019
2.45.1 2,057 9/15/2019
2.45.0 1,663 8/25/2019
2.44.0 1,647 8/2/2019
2.43.2 2,345 7/2/2019
2.43.1 1,493 6/14/2019
2.42.4 2,385 5/24/2019
2.42.3 13,286 5/13/2019
2.42.2 911 5/10/2019
2.42.0 1,214 4/22/2019
2.41.0 2,033 3/29/2019
2.40.11 2,374 2/16/2019
2.40.10 1,928 2/1/2019
2.40.9 1,003 1/31/2019
2.40.8 1,522 1/25/2019
2.40.7 2,745 1/4/2019
2.40.5 1,014 12/19/2018
2.40.4 2,847 11/26/2018
2.40.2 1,945 11/7/2018
2.40.1 1,582 10/29/2018
2.40.0 2,258 10/12/2018
2.39.2 3,249 9/9/2018
2.39.1 1,351 9/4/2018
2.39.0 1,368 9/2/2018
2.38.1 6,296 8/16/2018
2.38.0 1,891 8/13/2018
2.37.2 1,972 7/31/2018
2.37.1 1,257 7/31/2018
2.36.2 1,548 6/13/2018
2.36.1 1,600 5/25/2018
2.36.0 1,385 5/21/2018
2.36.0-alpha-0159-g25e5900b4 1,060 4/26/2018
2.35.4 1,545 5/2/2018
2.35.3 1,413 5/2/2018
2.35.0-alpha-0153-g6da267dd4 1,065 4/25/2018
2.33.2 1,553 4/3/2018
2.33.1 1,397 4/3/2018
2.33.0 1,520 3/19/2018
2.32.2 1,307 3/12/2018
2.32.0 1,482 2/28/2018
2.31.0 1,598 2/5/2018
2.30.0 1,587 1/12/2018
2.29.1 1,438 12/29/2017
2.28.3 1,368 12/14/2017
2.28.2 1,457 12/7/2017
2.28.1 1,329 12/1/2017
2.28.0 1,329 11/30/2017
2.27.0 1,339 11/21/2017
2.26.3 1,426 10/26/2017
2.26.1 1,318 10/24/2017
2.26.0 1,305 10/23/2017
2.25.1 1,333 10/9/2017
2.25.0 1,307 10/9/2017
2.24.0 1,512 9/11/2017
2.23.1 1,433 8/22/2017
2.22.3 1,320 8/17/2017
2.22.1 1,338 8/2/2017
2.22.0 1,357 8/1/2017
2.21.2 1,318 7/26/2017
2.21.1 1,421 7/17/2017
2.20.0 1,400 7/12/2017
2.19.2 1,381 6/29/2017
2.18.5 1,406 6/15/2017
2.18.4 1,362 6/9/2017
2.18.3 1,369 6/8/2017
2.18.1 1,322 5/31/2017
2.17.5 1,351 5/23/2017
2.17.3 1,342 5/11/2017
2.17.2 1,337 5/9/2017
2.16.8 1,377 5/3/2017
2.16.7 1,340 4/26/2017
2.16.5 1,319 4/25/2017
2.16.2 1,343 4/20/2017
2.16.0 1,401 4/17/2017
2.15.5 1,465 4/6/2017
2.15.2 1,369 3/29/2017
2.13.1 1,403 3/7/2017
2.13.0 1,390 3/6/2017
2.12.1 1,412 2/14/2017
2.12.0 1,363 2/13/2017
2.11.3 1,399 2/7/2017
2.11.2 1,370 1/25/2017
2.11.1 1,338 1/24/2017
2.11.0 1,336 1/23/2017
2.10.2 1,364 1/4/2017
2.10.1 1,320 1/4/2017
2.10.0 1,438 1/3/2017
2.9.3 1,345 12/15/2016
2.9.2 1,365 12/14/2016
2.9.1 1,317 12/13/2016
2.9.0 1,409 12/12/2016
2.8.2 1,384 11/28/2016
2.8.1 1,357 11/24/2016
2.8.0 1,417 11/22/2016
2.7.3 1,665 11/8/2016
2.7.2 1,614 11/3/2016
2.7.1 1,594 11/1/2016
2.7.0 1,414 10/31/2016
2.6.3 1,430 10/25/2016
2.6.1 1,369 10/11/2016
2.6.0 1,388 10/10/2016
2.5.4 1,874 9/22/2016
2.5.3 1,736 9/20/2016
2.5.2 1,513 9/19/2016
2.5.1 1,632 9/19/2016
2.5.0 1,422 9/14/2016
2.4.0 1,481 8/29/2016
2.3.1 1,417 8/22/2016
2.3.0 1,529 8/8/2016
2.2.2 1,432 7/22/2016
2.2.1 1,413 7/19/2016
2.2.0 1,411 7/18/2016
2.1.0 1,536 6/27/2016
2.0.2 1,364 6/22/2016
2.0.1 1,411 6/7/2016
2.0.0 1,521 6/6/2016
1.9.4 1,784 5/19/2016
1.9.3 1,383 5/19/2016
1.9.0 1,323 5/16/2016
1.8.4 1,379 5/10/2016
1.8.1 1,381 5/4/2016
1.8.0 1,635 4/25/2016
1.7.2 1,428 4/20/2016
1.7.1 1,391 4/7/2016
1.7.0 1,366 4/6/2016
1.6.1 1,439 3/16/2016
1.5.0 1,474 2/22/2016
1.4.2 1,447 2/3/2016
1.4.1 1,391 2/2/2016
1.4.0 1,415 2/1/2016
1.3.7 1,434 1/21/2016
1.3.5 1,432 1/13/2016
1.3.3 1,584 1/13/2016
1.3.0 1,414 1/11/2016
1.2.2 1,468 12/30/2015
1.2.1 1,390 12/15/2015
1.2.0 2,007 12/14/2015
1.1.0 1,448 12/9/2015
1.0.0 1,678 11/20/2015
0.3.11-alpha-9-gdaed198 1,136 11/16/2015
0.3.0 1,523 11/12/2015
0.0.1-alpha-1523061607 1,184 6/23/2015
0.0.1-alpha-1523061604 1,147 6/23/2015
0.0.1-alpha-1518061325 1,118 6/18/2015
0.0.1-alpha-1518061107 1,077 6/18/2015
0.0.1-alpha-1517061543 1,159 6/17/2015
0.0.1-alpha-1517061409 1,211 6/17/2015