Microsoft.DocAsCode.Build.UniversalReference 2.60.0

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 add package Microsoft.DocAsCode.Build.UniversalReference --version 2.60.0                

                    
                

            
NuGet\Install-Package Microsoft.DocAsCode.Build.UniversalReference -Version 2.60.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Microsoft.DocAsCode.Build.UniversalReference" Version="2.60.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Microsoft.DocAsCode.Build.UniversalReference --version 2.60.0                

                    
                

            
#r "nuget: Microsoft.DocAsCode.Build.UniversalReference, 2.60.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Microsoft.DocAsCode.Build.UniversalReference as a Cake Addin
#addin nuget:?package=Microsoft.DocAsCode.Build.UniversalReference&version=2.60.0

// Install Microsoft.DocAsCode.Build.UniversalReference as a Cake Tool
#tool nuget:?package=Microsoft.DocAsCode.Build.UniversalReference&version=2.60.0

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 ⚠️⚠️⚠️

For Microsoft Learn users, the open source version of docfx will NOT be maintained to support Microsoft Learn content. For Microsoft Learn feature requests, bug reports and other support ticks, use internal channels such as the Learn Platform Support Channel.

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 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Microsoft.DocAsCode.Build.UniversalReference:

Package Downloads
Microsoft.DocAsCode.App

Docfx published as a library for extensibility and advanced customization

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.67.5 9,571 6/21/2023 2.67.5 is deprecated because it is no longer maintained.
2.67.3 1,587 6/2/2023
2.67.2 451 5/26/2023
2.67.1 504 5/16/2023
2.67.0 863 5/6/2023
2.66.2 4,896 4/26/2023
2.66.1 323 4/25/2023
2.66.0 387 4/24/2023
2.65.3 418 4/14/2023
2.65.2 382 4/11/2023
2.65.1 339 4/9/2023
2.65.0 384 4/7/2023
2.64.0 497 3/30/2023
2.63.1 635 3/21/2023
2.63.0 391 3/20/2023
2.62.2 464 3/7/2023
2.62.1 1,903 2/15/2023
2.62.0 397 2/14/2023
2.61.0 2,359 1/30/2023
2.60.2 841 1/20/2023
2.60.1 462 1/18/2023
2.60.0 921 1/13/2023
2.60.0-preview.2 120 12/25/2022
2.59.4 6,796 9/7/2022
2.59.3 1,087 7/6/2022
2.59.2 1,021 4/11/2022
2.59.1 623 3/31/2022
2.59.0 910 1/19/2022
2.58.9 705 11/4/2021
2.58.8 466 11/1/2021
2.58.5 453 10/26/2021
2.58.4 527 9/14/2021
2.58.3 474 9/7/2021
2.58.2 485 8/24/2021
2.58.1 507 8/23/2021
2.58.0 749 6/9/2021
2.57.2 650 4/14/2021
2.57.1 509 4/13/2021
2.57.0 512 4/9/2021
2.56.7 1,658 3/2/2021
2.56.6 1,355 12/10/2020
2.56.5 599 11/10/2020
2.56.4 945 10/20/2020
2.56.3 658 10/12/2020
2.56.2 817 7/27/2020
2.56.1 685 7/6/2020
2.56.0 711 6/29/2020
2.55.0 682 6/12/2020
2.53.1 671 5/11/2020
2.52.0 948 4/13/2020
2.51.0 2,756 3/20/2020
2.50.0 1,040 3/2/2020
2.49.0 709 2/17/2020
2.48.1 2,234 1/13/2020
2.48.0 1,077 12/9/2019
2.47.0 1,155 10/31/2019
2.46.0 921 10/14/2019
2.45.1 2,756 9/15/2019
2.45.0 931 8/25/2019
2.44.0 996 8/2/2019
2.43.2 1,973 7/2/2019
2.43.1 967 6/14/2019
2.42.4 917 5/24/2019
2.42.3 13,074 5/13/2019
2.42.2 750 5/10/2019
2.42.0 819 4/22/2019
2.41.0 817 3/29/2019
2.40.12 758 3/11/2019
2.40.11 1,063 2/16/2019
2.40.10 828 2/1/2019
2.40.9 829 1/31/2019
2.40.8 807 1/25/2019
2.40.7 918 1/4/2019
2.40.5 819 12/19/2018
2.40.4 883 11/26/2018
2.40.2 901 11/7/2018
2.40.1 910 10/29/2018
2.40.0 929 10/12/2018
2.39.2 1,692 9/9/2018
2.39.1 2,292 9/4/2018
2.39.0 6,186 9/2/2018
2.38.1 5,520 8/16/2018
2.38.0 1,150 8/13/2018
2.37.2 1,037 7/31/2018
2.37.1 993 7/31/2018
2.36.2 1,157 6/13/2018
2.36.1 1,162 5/25/2018
2.36.0 1,122 5/21/2018
2.36.0-alpha-0159-g25e5900b4 872 4/26/2018
2.35.4 1,221 5/2/2018
2.35.3 1,231 5/2/2018
2.35.0-alpha-0153-g6da267dd4 903 4/25/2018
2.33.2 1,119 4/3/2018
2.33.1 1,047 4/3/2018
2.33.0 1,159 3/19/2018
2.32.2 1,153 3/12/2018
2.32.0 1,168 2/28/2018
2.31.0 1,246 2/5/2018
2.30.0 1,234 1/12/2018
2.29.1 1,150 12/29/2017
2.28.3 1,075 12/14/2017
2.28.2 1,185 12/7/2017
2.28.1 1,057 12/1/2017
2.28.0 1,067 11/30/2017
2.27.0 1,046 11/21/2017
2.26.3 1,067 10/26/2017
2.26.1 1,057 10/24/2017
2.26.0 1,098 10/23/2017
2.25.1 1,062 10/9/2017
2.25.0 1,053 10/9/2017
2.24.0 1,116 9/11/2017
2.23.1 1,069 8/22/2017
2.22.3 1,082 8/17/2017
2.22.1 1,077 8/2/2017
2.22.0 1,098 8/1/2017
2.21.2 1,107 7/26/2017
2.21.1 1,077 7/17/2017
2.20.0 1,076 7/12/2017
2.19.2 1,131 6/29/2017
2.18.5 1,097 6/15/2017
2.18.4 1,118 6/9/2017
2.18.3 1,187 6/8/2017
2.18.1 1,091 5/31/2017
2.17.5 1,185 5/23/2017
2.17.3 1,132 5/11/2017
2.17.2 1,143 5/9/2017