Microsoft.DocAsCode.Build.UniversalReference 2.62.0

Prefix Reserved

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

NuGet\Install-Package Microsoft.DocAsCode.Build.UniversalReference -Version 2.62.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.62.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Microsoft.DocAsCode.Build.UniversalReference" Version="2.62.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Microsoft.DocAsCode.Build.UniversalReference" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Microsoft.DocAsCode.Build.UniversalReference --version 2.62.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Microsoft.DocAsCode.Build.UniversalReference, 2.62.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.

#:package Microsoft.DocAsCode.Build.UniversalReference@2.62.0

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Microsoft.DocAsCode.Build.UniversalReference&version=2.62.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Microsoft.DocAsCode.Build.UniversalReference&version=2.62.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Build your docs with docfx

Getting Started
Contributing
Roadmap
.NET Foundation
License

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.

V3 branch has been privatized to support Microsoft Learn, the development of V3 branch in the public is officially stopped.

Getting Started

Install docfx as a global tool:
```
dotnet tool install -g docfx
```

Create and start a website locally:

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

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

Install Visual Studio 2022 (Community or higher) and make sure you have the latest updates.
Install .NET Core SDK 6.x and 7.x.
Install NodeJS (16.x.x).
Optional: Install wkhtmltopdf on Windows to test PDF using choco install wkhtmltopdf.

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. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- Microsoft.DocAsCode.Build.Common (>= 2.62.0)
- Microsoft.DocAsCode.Common (>= 2.62.0)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.62.0)
- Microsoft.DocAsCode.DataContracts.UniversalReference (>= 2.62.0)
- Microsoft.DocAsCode.YamlSerialization (>= 2.62.0)
net7.0
- Microsoft.DocAsCode.Build.Common (>= 2.62.0)
- Microsoft.DocAsCode.Common (>= 2.62.0)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.62.0)
- Microsoft.DocAsCode.DataContracts.UniversalReference (>= 2.62.0)
- Microsoft.DocAsCode.YamlSerialization (>= 2.62.0)

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	50.2K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
2.67.5	13,411	6/21/2023
2.67.3	1,745	6/2/2023
2.67.2	553	5/26/2023
2.67.1	612	5/16/2023
2.67.0	1,154	5/6/2023
2.66.2	5,415	4/26/2023
2.66.1	437	4/25/2023
2.66.0	513	4/24/2023
2.65.3	532	4/14/2023
2.65.2	496	4/11/2023
2.65.1	445	4/9/2023
2.65.0	496	4/7/2023
2.64.0	623	3/30/2023
2.63.1	803	3/21/2023
2.63.0	499	3/20/2023
2.62.2	599	3/7/2023
2.62.1	2,131	2/15/2023
2.62.0	506	2/14/2023
2.61.0	2,488	1/30/2023
2.60.2	970	1/20/2023
2.60.1	586	1/18/2023
2.60.0	1,132	1/13/2023
2.60.0-preview.2	209	12/25/2022
2.59.4	7,436	9/7/2022
2.59.3	1,295	7/6/2022
2.59.2	1,171	4/11/2022
2.59.1	757	3/31/2022
2.59.0	1,094	1/19/2022
2.58.9	877	11/4/2021
2.58.8	606	11/1/2021
2.58.5	596	10/26/2021
2.58.4	677	9/14/2021
2.58.3	609	9/7/2021
2.58.2	632	8/24/2021
2.58.1	645	8/23/2021
2.58.0	909	6/9/2021
2.57.2	808	4/14/2021
2.57.1	642	4/13/2021
2.57.0	666	4/9/2021
2.56.7	1,821	3/2/2021
2.56.6	1,521	12/10/2020
2.56.5	763	11/10/2020
2.56.4	1,110	10/20/2020
2.56.3	821	10/12/2020
2.56.2	984	7/27/2020
2.56.1	849	7/6/2020
2.56.0	882	6/29/2020
2.55.0	856	6/12/2020
2.53.1	854	5/11/2020
2.52.0	1,114	4/13/2020
2.51.0	2,929	3/20/2020
2.50.0	1,233	3/2/2020
2.49.0	887	2/17/2020
2.48.1	2,421	1/13/2020
2.48.0	1,254	12/9/2019
2.47.0	1,337	10/31/2019
2.46.0	1,106	10/14/2019
2.45.1	2,943	9/15/2019
2.45.0	1,104	8/25/2019
2.44.0	1,175	8/2/2019
2.43.2	2,154	7/2/2019
2.43.1	1,143	6/14/2019
2.42.4	1,096	5/24/2019
2.42.3	13,244	5/13/2019
2.42.2	931	5/10/2019
2.42.0	997	4/22/2019
2.41.0	998	3/29/2019
2.40.12	944	3/11/2019
2.40.11	1,241	2/16/2019
2.40.10	1,011	2/1/2019
2.40.9	1,006	1/31/2019
2.40.8	972	1/25/2019
2.40.7	1,099	1/4/2019
2.40.5	1,005	12/19/2018
2.40.4	1,076	11/26/2018
2.40.2	1,094	11/7/2018
2.40.1	1,115	10/29/2018
2.40.0	1,127	10/12/2018
2.39.2	2,017	9/9/2018
2.39.1	2,618	9/4/2018
2.39.0	6,508	9/2/2018
2.38.1	5,832	8/16/2018
2.38.0	1,469	8/13/2018
2.37.2	1,379	7/31/2018
2.37.1	1,342	7/31/2018
2.36.2	1,645	6/13/2018
2.36.1	1,655	5/25/2018
2.36.0	1,477	5/21/2018
2.36.0-alpha-0159-g25e5900b4	1,371	4/26/2018
2.35.4	1,718	5/2/2018
2.35.3	1,738	5/2/2018
2.35.0-alpha-0153-g6da267dd4	1,389	4/25/2018
2.33.2	1,623	4/3/2018
2.33.1	1,395	4/3/2018
2.33.0	1,672	3/19/2018
2.32.2	1,659	3/12/2018
2.32.0	1,673	2/28/2018
2.31.0	1,757	2/5/2018
2.30.0	1,740	1/12/2018
2.29.1	1,652	12/29/2017
2.28.3	1,414	12/14/2017
2.28.2	1,691	12/7/2017
2.28.1	1,413	12/1/2017
2.28.0	1,405	11/30/2017
2.27.0	1,404	11/21/2017
2.26.3	1,417	10/26/2017
2.26.1	1,409	10/24/2017
2.26.0	1,440	10/23/2017
2.25.1	1,412	10/9/2017
2.25.0	1,396	10/9/2017
2.24.0	1,468	9/11/2017
2.23.1	1,424	8/22/2017
2.22.3	1,438	8/17/2017
2.22.1	1,420	8/2/2017
2.22.0	1,455	8/1/2017
2.21.2	1,443	7/26/2017
2.21.1	1,427	7/17/2017
2.20.0	1,423	7/12/2017
2.19.2	1,481	6/29/2017
2.18.5	1,443	6/15/2017
2.18.4	1,465	6/9/2017
2.18.3	1,539	6/8/2017
2.18.1	1,432	5/31/2017
2.17.5	1,532	5/23/2017
2.17.3	1,480	5/11/2017
2.17.2	1,502	5/9/2017

Total 199.1K

Current version 506

Per day average 63