docfx 2.63.1

.NET 6.0 
dotnet tool install --global docfx --version 2.63.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.63.1
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=docfx&version=2.63.1
nuke :add-package docfx --version 2.63.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.
    • 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 occationally 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.

.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 Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows net8.0
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
2.63.1 1,153 3/21/2023
2.63.0 707 3/20/2023
2.62.2 5,218 3/7/2023
2.62.1 7,243 2/15/2023
2.62.0 549 2/14/2023
2.61.0 8,357 1/30/2023
2.60.2 6,885 1/20/2023
2.60.1 1,013 1/18/2023
2.60.0 1,900 1/13/2023
2.60.0-preview.2 689 12/25/2022
2.60.0-preview.1 377 12/20/2022
2.59.4 1,224 9/7/2022
2.59.3 861 7/6/2022
2.59.2 1,120 4/11/2022
2.59.1 574 3/31/2022
2.59.0 871 1/19/2022
2.58.9 918 11/4/2021
2.58.8 338 11/1/2021
2.58.5 365 10/26/2021
2.58.4 1,419 9/14/2021
2.58.3 594 9/7/2021
2.58.2 962 8/24/2021
2.58.1 356 8/23/2021
2.58.0 3,220 6/9/2021
2.57.2 1,456 4/14/2021
2.57.1 435 4/13/2021
2.57.0 524 4/9/2021
2.56.7 2,831 3/2/2021
2.56.6 4,089 12/10/2020
2.56.5 1,244 11/10/2020
2.56.4 884 10/20/2020
2.56.3 588 10/12/2020
2.56.2 2,205 7/27/2020
2.56.1 1,079 7/6/2020
2.56.0 803 6/29/2020
2.55.0 1,003 6/12/2020
2.53.1 2,094 5/11/2020
2.52.0 1,580 4/13/2020
2.51.0 1,424 3/20/2020
2.50.0 1,510 3/2/2020
2.49.0 651 2/17/2020
2.48.1 2,084 1/13/2020
2.48.0 1,916 12/9/2019
2.47.0 1,898 10/31/2019
2.46.0 1,247 10/14/2019
2.45.1 1,845 9/15/2019
2.45.0 1,479 8/25/2019
2.44.0 1,453 8/2/2019
2.43.2 2,181 7/2/2019
2.43.1 1,312 6/14/2019
2.42.4 2,181 5/24/2019
2.42.3 13,078 5/13/2019
2.42.2 743 5/10/2019
2.42.0 1,023 4/22/2019
2.41.0 1,824 3/29/2019
2.40.11 2,134 2/16/2019
2.40.10 1,717 2/1/2019
2.40.9 798 1/31/2019
2.40.8 1,336 1/25/2019
2.40.7 2,549 1/4/2019
2.40.5 830 12/19/2018
2.40.4 2,647 11/26/2018
2.40.2 1,737 11/7/2018
2.40.1 1,383 10/29/2018
2.40.0 1,976 10/12/2018
2.39.2 3,017 9/9/2018
2.39.1 1,143 9/4/2018
2.39.0 1,145 9/2/2018
2.38.1 6,051 8/16/2018
2.38.0 1,661 8/13/2018
2.37.2 1,719 7/31/2018
2.37.1 1,003 7/31/2018
2.36.2 1,317 6/13/2018
2.36.1 1,343 5/25/2018
2.36.0 1,113 5/21/2018
2.36.0-alpha-0159-g25e5900b4 888 4/26/2018
2.35.4 1,243 5/2/2018
2.35.3 1,138 5/2/2018
2.35.0-alpha-0153-g6da267dd4 867 4/25/2018
2.33.2 1,299 4/3/2018
2.33.1 1,115 4/3/2018
2.33.0 1,222 3/19/2018
2.32.2 1,083 3/12/2018
2.32.0 1,206 2/28/2018
2.31.0 1,275 2/5/2018
2.30.0 1,249 1/12/2018
2.29.1 1,151 12/29/2017
2.28.3 1,104 12/14/2017
2.28.2 1,177 12/7/2017
2.28.1 1,073 12/1/2017
2.28.0 1,078 11/30/2017
2.27.0 1,074 11/21/2017
2.26.3 1,174 10/26/2017
2.26.1 1,040 10/24/2017
2.26.0 1,052 10/23/2017
2.25.1 1,091 10/9/2017
2.25.0 1,044 10/9/2017
2.24.0 1,206 9/11/2017
2.23.1 1,162 8/22/2017
2.22.3 1,056 8/17/2017
2.22.1 1,100 8/2/2017
2.22.0 1,108 8/1/2017
2.21.2 1,059 7/26/2017
2.21.1 1,148 7/17/2017
2.20.0 1,114 7/12/2017
2.19.2 1,103 6/29/2017
2.18.5 1,137 6/15/2017
2.18.4 1,088 6/9/2017
2.18.3 1,101 6/8/2017
2.18.1 1,086 5/31/2017
2.17.5 1,115 5/23/2017
2.17.3 1,084 5/11/2017
2.17.2 1,074 5/9/2017
2.16.8 1,114 5/3/2017
2.16.7 1,087 4/26/2017
2.16.5 1,068 4/25/2017
2.16.2 1,068 4/20/2017
2.16.0 1,110 4/17/2017
2.15.5 1,206 4/6/2017
2.15.2 1,091 3/29/2017
2.13.1 1,129 3/7/2017
2.13.0 1,120 3/6/2017
2.12.1 1,140 2/14/2017
2.12.0 1,102 2/13/2017
2.11.3 1,115 2/7/2017
2.11.2 1,096 1/25/2017
2.11.1 1,096 1/24/2017
2.11.0 1,090 1/23/2017
2.10.2 1,131 1/4/2017
2.10.1 1,071 1/4/2017
2.10.0 1,128 1/3/2017
2.9.3 1,108 12/15/2016
2.9.2 1,109 12/14/2016
2.9.1 1,072 12/13/2016
2.9.0 1,108 12/12/2016
2.8.2 1,124 11/28/2016
2.8.1 1,101 11/24/2016
2.8.0 1,114 11/22/2016
2.7.3 1,394 11/8/2016
2.7.2 1,340 11/3/2016
2.7.1 1,346 11/1/2016
2.7.0 1,111 10/31/2016
2.6.3 1,150 10/25/2016
2.6.1 1,089 10/11/2016
2.6.0 1,102 10/10/2016
2.5.4 1,551 9/22/2016
2.5.3 1,480 9/20/2016
2.5.2 1,270 9/19/2016
2.5.1 1,346 9/19/2016
2.5.0 1,133 9/14/2016
2.4.0 1,181 8/29/2016
2.3.1 1,113 8/22/2016
2.3.0 1,240 8/8/2016
2.2.2 1,145 7/22/2016
2.2.1 1,134 7/19/2016
2.2.0 1,149 7/18/2016
2.1.0 1,234 6/27/2016
2.0.2 1,098 6/22/2016
2.0.1 1,145 6/7/2016
2.0.0 1,186 6/6/2016
1.9.4 1,467 5/19/2016
1.9.3 1,111 5/19/2016
1.9.0 1,090 5/16/2016
1.8.4 1,119 5/10/2016
1.8.1 1,120 5/4/2016
1.8.0 1,386 4/25/2016
1.7.2 1,160 4/20/2016
1.7.1 1,133 4/7/2016
1.7.0 1,112 4/6/2016
1.6.1 1,173 3/16/2016
1.5.0 1,213 2/22/2016
1.4.2 1,184 2/3/2016
1.4.1 1,107 2/2/2016
1.4.0 1,133 2/1/2016
1.3.7 1,168 1/21/2016
1.3.5 1,157 1/13/2016
1.3.3 1,287 1/13/2016
1.3.0 1,175 1/11/2016
1.2.2 1,207 12/30/2015
1.2.1 1,149 12/15/2015
1.2.0 1,441 12/14/2015
1.1.0 1,165 12/9/2015
1.0.0 1,401 11/20/2015
0.3.11-alpha-9-gdaed198 973 11/16/2015
0.3.0 1,231 11/12/2015
0.0.1-alpha-1523061607 988 6/23/2015
0.0.1-alpha-1523061604 982 6/23/2015
0.0.1-alpha-1518061325 921 6/18/2015
0.0.1-alpha-1518061107 920 6/18/2015
0.0.1-alpha-1517061543 925 6/17/2015
0.0.1-alpha-1517061409 998 6/17/2015