Microsoft.DocAsCode.Build.SchemaDriven 2.67.5
前缀已预留
建议替代方案
其他详细信息
Docfx 已完全转型为完全由社区推动的 .NET 基金会项目,故我们将 NuGet 包名、程序集名和命名空间名从 Microsoft.DocAsCode.* 更改为 Docfx.*。
dotnet add package Microsoft.DocAsCode.Build.SchemaDriven --version 2.67.5
NuGet\Install-Package Microsoft.DocAsCode.Build.SchemaDriven -Version 2.67.5
此命令用于 Visual Studio 中的包管理器控制台,因为它使用了 NuGet 模块的 Install-Package 版本。
<PackageReference Include="Microsoft.DocAsCode.Build.SchemaDriven" Version="2.67.5" />
对于支持 PackageReference 的项目,将此 XML 节点复制到项目文件中以引用包。
paket add Microsoft.DocAsCode.Build.SchemaDriven --version 2.67.5
NuGet 团队不提供对此客户端的支持。请联系其 维护者 以获得支持。
#r "nuget: Microsoft.DocAsCode.Build.SchemaDriven, 2.67.5"
#r 指令可用于 F# Interactive 和 Polyglot Notebooks。将其复制到交互式工具或脚本的源代码中,以引用包。
// Install Microsoft.DocAsCode.Build.SchemaDriven as a Cake Addin #addin nuget:?package=Microsoft.DocAsCode.Build.SchemaDriven&version=2.67.5 // Install Microsoft.DocAsCode.Build.SchemaDriven as a Cake Tool #tool nuget:?package=Microsoft.DocAsCode.Build.SchemaDriven&version=2.67.5
NuGet 团队不提供对此客户端的支持。请联系其 维护者 以获得支持。
使用 docfx 创建文档
使用 docfx 构建技术文档网站,包括着陆页、Markdown、.NET、REST API 等的 API 参考文档。
⚠️⚠️⚠️ 注意 ⚠️⚠️⚠️
DocFX 正在转型为 .NET Foundation 的官方 .NET 项目!
- DocFX 团队正在改进主分支。这将向项目引入新功能和错误修复,删除一些不再必要的旧代码和功能,以及更新依赖项并简化项目结构。请关注路线图。
- 由于站点架构变更,DocFX不能再直接支持构建Microsoft Learn内容。承载Microsoft Learn Markdown内容的开源库仍将接受pull请求和更改,但不能直接使用DocFX构建。
- 未来,我们只将支持此工具作为新站点的静态网站生成器,而不是作为在Microsoft Learn上构建官方Microsoft内容的工具。
入门
安装docfx为全局工具
dotnet tool install -g docfx
在本地创建并启动一个网站
docfx init -q docfx build docfx_project\docfx.json --serve
访问https://127.0.0.1:8080查看样本网站。
有关更多信息,请参阅入门。
贡献
我们欢迎通过pull请求进行代码贡献,标记为help-wanted
的问题是开始贡献代码的好候选。
先决条件
- 安装Visual Studio 2022(社区版或更高版本)并确保您有最新的更新。
- 安装.NET Core SDK 6.x和7.x。
- 安装NodeJS (16.x.x)。
- 可选:在Windows上安装wkhtmltopdf以使用
choco install wkhtmltopdf
测试PDF。
构建和测试
- 在
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 Foundation
本项目由.NET Foundation支持。
本项目采用了由贡献者公约定义的行为准则以阐明我们社区中预期的行为。有关更多信息,请参阅.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 已计算。 |
-
net6.0
- JsonSchema.Net (>= 4.1.5)
- Markdig (>= 0.31.0)
- Microsoft.DocAsCode.Build.Common (>= 2.67.5)
- Microsoft.DocAsCode.Build.OverwriteDocuments (>= 2.67.5)
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.5)
- Microsoft.DocAsCode.MarkdigEngine (>= 2.67.5)
- Microsoft.DocAsCode.Plugins (>= 2.67.5)
-
net7.0
- JsonSchema.Net (>= 4.1.5)
- Markdig (>= 0.31.0)
- Microsoft.DocAsCode.Build.Common (>= 2.67.5)
- Microsoft.DocAsCode.Build.OverwriteDocuments (>= 2.67.5)
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.5)
- Microsoft.DocAsCode.MarkdigEngine (>= 2.67.5)
- Microsoft.DocAsCode.Plugins (>= 2.67.5)
-
net8.0
- JsonSchema.Net (>= 4.1.5)
- Markdig (>= 0.31.0)
- Microsoft.DocAsCode.Build.Common (>= 2.67.5)
- Microsoft.DocAsCode.Build.OverwriteDocuments (>= 2.67.5)
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.5)
- Microsoft.DocAsCode.MarkdigEngine (>= 2.67.5)
- Microsoft.DocAsCode.Plugins (>= 2.67.5)
NuGet 包 (2)
显示依赖于 Microsoft.DocAsCode.Build.SchemaDriven 的前两个 NuGet 包
包名称 | 下载 |
---|---|
Microsoft.DocAsCode.Build.Engine 包描述 |
|
Microsoft.DocAsCode.App Docfx以库格式发布,以支持扩展和高级定制 |
GitHub仓库
此包没有被任何流行的GitHub仓库使用。
版本 | 下载 | 最后更新 | |
---|---|---|---|
2.67.5 | 8,629 | 6/21/2023 | |
2.67.3 | 1,620 | 6/2/2023 | |
2.67.2 | 466 | 5/26/2023 | |
2.67.1 | 503 | 5/16/2023 | |
2.67.0 | 907 | 5/6/2023 | |
2.66.2 | 4,732 | 4/26/2023 | |
2.66.1 | 1,416 | 4/25/2023 | |
2.66.0 | 435 | 4/24/2023 | |
2.65.3 | 493 | 4/14/2023 | |
2.65.2 | 456 | 4/11/2023 | |
2.65.1 | 412 | 4/9/2023 | |
2.65.0 | 446 | 4/7/2023 | |
2.64.0 | 584 | 3/30/2023 | |
2.63.1 | 709 | 3/21/2023 | |
2.63.0 | 493 | 3/20/2023 | |
2.62.2 | 515 | 3/7/2023 | |
2.62.1 | 1,921 | 2/15/2023 | |
2.62.0 | 446 | 2/14/2023 | |
2.61.0 | 2,422 | 1/30/2023 | |
2.60.2 | 928 | 1/20/2023 | |
2.60.1 | 570 | 1/18/2023 | |
2.60.0 | 1,028 | 1/13/2023 | |
2.60.0-preview.2 | 133 | 12/25/2022 | |
2.60.0-preview.1 | 126 | 12/20/2022 | |
2.59.4 | 6,396 | 9/7/2022 | |
2.59.3 | 1,081 | 7/6/2022 | |
2.59.2 | 1,091 | 4/11/2022 | |
2.59.1 | 794 | 3/31/2022 | |
2.59.0 | 3,182 | 1/19/2022 | |
2.58.9 | 891 | 11/4/2021 | |
2.58.8 | 532 | 11/1/2021 | |
2.58.5 | 554 | 10/26/2021 | |
2.58.4 | 643 | 9/14/2021 | |
2.58.3 | 533 | 9/7/2021 | |
2.58.2 | 587 | 8/24/2021 | |
2.58.1 | 561 | 8/23/2021 | |
2.58.0 | 800 | 6/9/2021 | |
2.57.2 | 668 | 4/14/2021 | |
2.57.1 | 570 | 4/13/2021 | |
2.57.0 | 577 | 4/9/2021 | |
2.56.7 | 1,695 | 3/2/2021 | |
2.56.6 | 1,452 | 12/10/2020 | |
2.56.5 | 714 | 11/10/2020 | |
2.56.4 | 2,604 | 10/20/2020 | |
2.56.3 | 680 | 10/12/2020 | |
2.56.2 | 909 | 7/27/2020 | |
2.56.1 | 821 | 7/6/2020 | |
2.56.0 | 832 | 6/29/2020 | |
2.55.0 | 988 | 6/12/2020 | |
2.53.1 | 869 | 5/11/2020 | |
2.52.0 | 1,003 | 4/13/2020 | |
2.51.0 | 2,916 | 3/20/2020 | |
2.50.0 | 1,010 | 3/2/2020 | |
2.49.0 | 888 | 2/17/2020 | |
2.48.1 | 2,523 | 1/13/2020 | |
2.48.0 | 1,602 | 12/9/2019 | |
2.47.0 | 1,207 | 10/31/2019 | |
2.46.0 | 1,330 | 10/14/2019 | |
2.45.1 | 3,018 | 9/15/2019 | |
2.45.0 | 1,090 | 8/25/2019 | |
2.44.0 | 1,799 | 8/2/2019 | |
2.43.2 | 1,913 | 7/2/2019 | |
2.43.1 | 1,044 | 6/14/2019 | |
2.42.4 | 1,891 | 5/24/2019 | |
2.42.3 | 13,293 | 5/13/2019 | |
2.42.2 | 895 | 5/10/2019 | |
2.42.0 | 1,005 | 4/22/2019 | |
2.41.0 | 3,003 | 3/29/2019 | |
2.40.12 | 930 | 3/11/2019 | |
2.40.11 | 2,076 | 2/16/2019 | |
2.40.10 | 1,066 | 2/1/2019 | |
2.40.9 | 1,129 | 1/31/2019 | |
2.40.8 | 1,147 | 1/25/2019 | |
2.40.7 | 1,027 | 1/4/2019 | |
2.40.5 | 1,075 | 12/19/2018 | |
2.40.4 | 1,030 | 11/26/2018 | |
2.40.2 | 1,038 | 11/7/2018 | |
2.40.1 | 1,036 | 10/29/2018 | |
2.40.0 | 1,077 | 10/12/2018 | |
2.39.2 | 2,608 | 9/9/2018 | |
2.39.1 | 2,462 | 9/4/2018 | |
2.39.0 | 5,581 | 9/2/2018 | |
2.38.1 | 5,707 | 8/16/2018 | |
2.38.0 | 1,305 | 8/13/2018 | |
2.37.2 | 1,151 | 7/31/2018 | |
2.37.1 | 1,446 | 7/31/2018 | |
2.36.2 | 1,442 | 6/13/2018 | |
2.36.1 | 1,299 | 5/25/2018 | |
2.36.0 | 1,336 | 5/21/2018 | |
2.36.0-alpha-0159-g25e5900b4 | 931 | 4/26/2018 | |
2.35.4 | 1,366 | 5/2/2018 | |
2.35.3 | 1,299 | 5/2/2018 | |
2.35.0-alpha-0153-g6da267dd4 | 926 | 4/25/2018 | |
2.33.2 | 1,637 | 4/3/2018 | |
2.33.1 | 1,276 | 4/3/2018 | |
2.33.0 | 1,254 | 3/19/2018 | |
2.32.2 | 1,270 | 3/12/2018 | |
2.32.0 | 1,289 | 2/28/2018 | |
2.31.0 | 1,344 | 2/5/2018 | |
2.30.0 | 1,429 | 1/12/2018 | |
2.29.1 | 1,443 | 12/29/2017 | |
2.28.3 | 1,253 | 12/14/2017 | |
2.28.2 | 1,307 | 12/7/2017 | |
2.28.1 | 1,281 | 12/1/2017 | |
2.28.0 | 1,244 | 11/30/2017 | |
2.27.0 | 1,258 | 11/21/2017 | |
2.26.3 | 1,336 | 10/26/2017 | |
2.26.1 | 1,228 | 10/24/2017 | |
2.26.0 | 1,215 | 10/23/2017 | |
2.25.1 | 1,204 | 10/9/2017 | |
2.25.0 | 1,404 | 10/9/2017 | |
2.24.0 | 1,288 | 9/11/2017 | |
2.23.1 | 1,265 | 8/22/2017 |