Microsoft.DocAsCode.Build.UniversalReference 2.67.5

前缀已保留
建议的替代方案

Docfx.Build.UniversalReference

附加详情

Docfx 已经完全过渡到一个完全由社区驱动、以社区利益为目标的 .NET 基金会项目。因此,我们将 NuGet 包名、程序集名和命名空间名从 Microsoft.DocAsCode.* 更改到 Docfx.*。

dotnet add package Microsoft.DocAsCode.Build.UniversalReference --version 2.67.5                
NuGet\Install-Package Microsoft.DocAsCode.Build.UniversalReference -Version 2.67.5                
此命令旨在在 Visual Studio 的包管理器控制台中使用,因为它使用 NuGet 模块的 Install-Package 版本。
<PackageReference Include="Microsoft.DocAsCode.Build.UniversalReference" Version="2.67.5" />                
对于支持 包引用 的项目,将此 XML 节点复制到项目文件中以引用包。
paket add Microsoft.DocAsCode.Build.UniversalReference --version 2.67.5                
#r "nuget: Microsoft.DocAsCode.Build.UniversalReference, 2.67.5"                
#r 指令可用于 F# Interactive 和多语言笔记本。将此内容复制到交互式工具或脚本的源代码中以引用包。
// Install Microsoft.DocAsCode.Build.UniversalReference as a Cake Addin
#addin nuget:?package=Microsoft.DocAsCode.Build.UniversalReference&version=2.67.5

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

使用 docfx 构建您的文档

NuGet Help Wanted Gitter

使用 docfx 构建您的技术文档站点,包括着陆页、Markdown、.NET、REST API 的 API 参考文档等。

⚠️⚠️⚠️ 注意⚠️⚠️⚠️

DocFX 正在过渡到 .NET 基金会,成为一个官方的 .NET 项目!

  • DocFX 团队正在改进主分支。这将向项目引入新功能和错误修复,删除一些不再必要的较旧代码和功能,以及更新依赖项并简化项目结构。请密切关注路线图。
  • 由于网站架构变更[1],DocFX不再支持直接构建Microsoft Learn的内容。用于存储Microsoft Learn Markdown内容的开源仓库仍将接受pull请求和更改,但无法直接使用DocFX构建。
  • 未来,我们只会将该工具作为新网站的静态站点生成器支持,而不是在Microsoft Learn上构建官方Microsoft内容的工具。

入门

  1. 将docfx作为全局工具安装

    dotnet tool install -g docfx
    
  2. 本地创建并启动一个网站

    docfx init -q
    docfx build docfx_project\docfx.json --serve
    
  3. 访问https://localhost:8080查看示例网站。

有关更多信息,请参阅入门指南

贡献

对于问题和一般讨论,请使用讨论区。对于报告错误和提出功能,请使用问题

我们欢迎通过pull请求进行代码贡献。标注为help-wanted的问题是很不错的开始贡献代码的选择。

先决条件

构建和测试

  • templates目录中构建站点模板
    • 运行npm install以还原npm依赖。
    • 运行npm run build以构建模板。
  • 运行dotnet build来构建项目或使用Visual Studio构建docfx.sln
  • 运行dotnet test来测试项目或使用Visual Studio测试资源管理器。
    • 运行git lfs checkout以检出文件以进行快照测试

分支和发布

main分支是pull请求和其他大多数开发活动的默认分支。我们偶尔使用feature/*分支进行史诗级功能开发。

发布基于稳定的main分支提交,使用GitHub Releases。鼓励使用惯例提交

Docfx不按常规的节奏发布,新版本出现在维护者认为有足够变化值得发布新版本时。有时我们使用预发布版来测试破坏性更改并从社区获取反馈。

路线图

我们使用里程碑来沟通即将到来的docfx更改

  • 工作集是正在积极开发的功能。并非这个桶中的所有功能都会在下一个版本中提交,但它们反映了维护者在即将到来的期间最关注的问题。

  • 待办事项是一组候选功能,适用于某些未来的版本,但目前正在积极开发中。

许可证

本项目根据MIT许可协议授权。

.NET 基金会

本项目由.NET Foundation支持。

本项目采用了由Contributor Covenant定义的行为准则,以阐明我们社区中期望的行为。有关更多信息,请参阅.NET Foundation的行为准则

产品 兼容和额外的目标框架版本。
.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 兼容。 net8.0-android 已计算。 net8.0-browser 已计算。 net8.0-ios 已计算。 net8.0-maccatalyst 已计算。 net8.0-macos 已计算。 net8.0-tvos 已计算。 net8.0-windows 已计算。
兼容的目标框架
包括的目标框架(包中包含的)
了解更多关于 目标框架.NET 标准化

NuGet 包 (1)

显示依赖 Microsoft.DocAsCode.Build.UniversalReference 的顶级 1 个 NuGet 包

下载
Microsoft.DocAsCode.App

Docfx 作为库发布用于扩展和高级定制

GitHub 仓库

此包未被任何流行的GitHub仓库使用。

版本 下载 上次更新
2.67.5 8,416 6/21/2023 2.67.5 已弃用,因为它不再维护。
2.67.3 1,557 6/2/2023
2.67.2 408 5/26/2023
2.67.1 468 5/16/2023
2.67.0 830 5/6/2023
2.66.2 4,648 4/26/2023
2.66.1 292 4/25/2023
2.66.0 353 4/24/2023
2.65.3 388 4/14/2023
2.65.2 360 4/11/2023
2.65.1 308 4/9/2023
2.65.0 355 4/7/2023
2.64.0 467 3/30/2023
2.63.1 583 3/21/2023
2.63.0 361 3/20/2023
2.62.2 429 3/7/2023
2.62.1 1,844 2/15/2023
2.62.0 361 2/14/2023
2.61.0 2,326 1/30/2023
2.60.2 808 1/20/2023
2.60.1 431 1/18/2023
2.60.0 871 1/13/2023
2.60.0-preview.2 107 12/25/2022
2.59.4 6,234 9/7/2022
2.59.3 1,048 7/6/2022
2.59.2 985 4/11/2022
2.59.1 593 3/31/2022
2.59.0 870 1/19/2022
2.58.9 669 11/4/2021
2.58.8 439 11/1/2021
2.58.5 424 10/26/2021
2.58.4 497 9/14/2021
2.58.3 444 9/7/2021
2.58.2 454 8/24/2021
2.58.1 478 8/23/2021
2.58.0 710 6/9/2021
2.57.2 614 4/14/2021
2.57.1 472 4/13/2021
2.57.0 482 4/9/2021
2.56.7 1,627 3/2/2021
2.56.6 1,315 12/10/2020
2.56.5 562 11/10/2020
2.56.4 909 10/20/2020
2.56.3 625 10/12/2020
2.56.2 785 7/27/2020
2.56.1 653 7/6/2020
2.56.0 677 6/29/2020
2.55.0 650 6/12/2020
2.53.1 640 5/11/2020
2.52.0 918 4/13/2020
2.51.0 2,725 3/20/2020
2.50.0 1,003 3/2/2020
2.49.0 682 2/17/2020
2.48.1 2,194 1/13/2020
2.48.0 1,045 12/9/2019
2.47.0 1,127 10/31/2019
2.46.0 889 10/14/2019
2.45.1 2,724 9/15/2019
2.45.0 898 8/25/2019
2.44.0 962 8/2/2019
2.43.2 1,945 7/2/2019
2.43.1 939 6/14/2019
2.42.4 886 5/24/2019
2.42.3 13,047 5/13/2019
2.42.2 721 5/10/2019
2.42.0 786 4/22/2019
2.41.0 788 3/29/2019
2.40.12 728 3/11/2019
2.40.11 1,033 2/16/2019
2.40.10 795 2/1/2019
2.40.9 795 1/31/2019
2.40.8 778 1/25/2019
2.40.7 884 1/4/2019
2.40.5 790 12/19/2018
2.40.4 850 11/26/2018
2.40.2 886 11/7/2018
2.40.1 881 10/29/2018
2.40.0 891 10/12/2018
2.39.2 1,655 9/9/2018
2.39.1 2,262 9/4/2018
2.39.0 6,139 9/2/2018
2.38.1 5,457 8/16/2018
2.38.0 1,099 8/13/2018
2.37.2 1,002 7/31/2018
2.37.1 958 7/31/2018
2.36.2 1,121 6/13/2018
2.36.1 1,127 5/25/2018
2.36.0 1,088 5/21/2018
2.36.0-alpha-0159-g25e5900b4 843 4/26/2018
2.35.4 1,181 5/2/2018
2.35.3 1,192 5/2/2018
2.35.0-alpha-0153-g6da267dd4 871 4/25/2018
2.33.2 1,082 4/3/2018
2.33.1 1,012 4/3/2018
2.33.0 1,118 3/19/2018
2.32.2 1,131 3/12/2018
2.32.0 1,146 2/28/2018
2.31.0 1,208 2/5/2018
2.30.0 1,199 1/12/2018
2.29.1 1,097 12/29/2017
2.28.3 1,039 12/14/2017
2.28.2 1,153 12/7/2017
2.28.1 1,023 12/1/2017
2.28.0 999 11/30/2017
2.27.0 1,011 11/21/2017
2.26.3 1,035 10/26/2017
2.26.1 1,022 10/24/2017
2.26.0 1,060 10/23/2017
2.25.1 1,025 10/9/2017
2.25.0 1,019 10/9/2017
2.24.0 1,084 9/11/2017
2.23.1 1,035 8/22/2017
2.22.3 1,048 8/17/2017
2.22.1 1,044 8/2/2017
2.22.0 1,064 8/1/2017
2.21.2 1,071 7/26/2017
2.21.1 1,031 7/17/2017
2.20.0 1,036 7/12/2017
2.19.2 1,077 6/29/2017
2.18.5 1,065 6/15/2017
2.18.4 1,084 6/9/2017
2.18.3 1,141 6/8/2017
2.18.1 1,058 5/31/2017
2.17.5 1,152 5/23/2017
2.17.3 1,097 5/11/2017
2.17.2 1,103 5/9/2017