Microsoft.DocAsCode.Build.Engine 2.67.5
前缀已保留
建议的替代方案
更多详细信息
Docfx 已经完全转型成为由社区驱动的 .NET 基金会项目。因此,我们将 NuGet 包名、程序集名和命名空间名从 Microsoft.DocAsCode.* 更改为 Docfx.*。
dotnet add package Microsoft.DocAsCode.Build.Engine --version 2.67.5
NuGet\Install-Package Microsoft.DocAsCode.Build.Engine -Version 2.67.5
命令旨在在 Visual Studio 的包管理器控制台内使用,因为它使用 NuGet 模块的 Install-Package 版本。
<PackageReference Include="Microsoft.DocAsCode.Build.Engine" Version="2.67.5" />
对于支持 PackageReference 的项目,将此 XML 节点复制到项目文件中以引用包。
paket add Microsoft.DocAsCode.Build.Engine --version 2.67.5
NuGet 团队不提供对此客户端的支持。请联系其 维护者 以获得支持。
#r "nuget: Microsoft.DocAsCode.Build.Engine, 2.67.5"
#r 指令可以用于 F# Interactive 和 Polyglot Notebooks。将其复制到交互式工具或脚本的源代码中以引用包。
// Install Microsoft.DocAsCode.Build.Engine as a Cake Addin #addin nuget:?package=Microsoft.DocAsCode.Build.Engine&version=2.67.5 // Install Microsoft.DocAsCode.Build.Engine as a Cake Tool #tool nuget:?package=Microsoft.DocAsCode.Build.Engine&version=2.67.5
NuGet 团队不提供对此客户端的支持。请联系其 维护者 以获得支持。
使用 docfx 构建您的文档
使用 docfx,利用落地页面、Markdown、.NET、REST API 等构建您的技术文档网站。
⚠️⚠️⚠️ 注意⚠️⚠️⚠️
DocFX 正在转型为 .NET 基金会的官方 .NET 项目!
- DocFX 团队正在改进主分支。这将向项目引入新功能和错误修复,移除一些不再必要的旧代码和功能,以及更新依赖关系和简化项目结构。请关注路线图。
- 由于网站架构变更(参见 此链接),DocFX不能再建立Microsoft Learn内容。存储Microsoft Learn Markdown内容的开源仓库将继续接受Pull请求和更改,但不能直接使用DocFX构建。
- 展望未来,我们仅将支持将该工具作为新网站的静态网站生成器,而不是构建Microsoft Learn正式内容的工具。
入门
将docfx安装为全局工具
dotnet tool install -g docfx
本地创建并启动一个网站
docfx init -q docfx build docfx_project\docfx.json --serve
访问https://localhost:8080查看示例网站。
有关更多信息,请参阅入门指南。
参与贡献
使用讨论提问和进行一般讨论。使用问题追踪来报告错误和建议新特性。
我们欢迎通过Pull请求贡献代码。标记为help-wanted
的问题是很好的代码贡献起点。
先决条件
- 安装Visual Studio 2022(社区版或更高版本)并确保您安装了最新更新。
- 安装.NET Core SDK 6.x和7.x。
- 安装NodeJS (16.x.x)。
- 可选:在Windows上安装wkhtmltopdf来测试PDF,使用
choco install wkhtmltopdf
。
构建和测试
- 在
templates
目录下构建网站模板- 运行
npm install
以还原npm依赖项。 - 运行
npm run build
以构建模板。
- 运行
- 运行
dotnet build
来构建项目或使用Visual Studio构建docfx.sln
。 - 运行
dotnet test
来测试项目或使用Visual Studio测试资源管理器。- 运行
git lfs checkout
以检出用于快照测试的文件
- 运行
分支和发布
main
分支是pull request和大多数其他开发活动的默认分支。我们偶尔使用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 已计算。 |
-
net6.0
- Jint (>= 3.0.0-beta-2049)
- Microsoft.DocAsCode.Build.Common (>= 2.67.5)
- Microsoft.DocAsCode.Build.SchemaDriven (>= 2.67.5)
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.5)
- Microsoft.DocAsCode.Glob (>= 2.67.5)
- Microsoft.DocAsCode.Plugins (>= 2.67.5)
- Microsoft.DocAsCode.YamlSerialization (>= 2.67.5)
- Stubble.Core (>= 1.10.8)
-
net7.0
- Jint (>= 3.0.0-beta-2049)
- Microsoft.DocAsCode.Build.Common (>= 2.67.5)
- Microsoft.DocAsCode.Build.SchemaDriven (>= 2.67.5)
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.5)
- Microsoft.DocAsCode.Glob (>= 2.67.5)
- Microsoft.DocAsCode.Plugins (>= 2.67.5)
- Microsoft.DocAsCode.YamlSerialization (>= 2.67.5)
- Stubble.Core (>= 1.10.8)
-
net8.0
- Jint (>= 3.0.0-beta-2049)
- Microsoft.DocAsCode.Build.Common (>= 2.67.5)
- Microsoft.DocAsCode.Build.SchemaDriven (>= 2.67.5)
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.5)
- Microsoft.DocAsCode.Glob (>= 2.67.5)
- Microsoft.DocAsCode.Plugins (>= 2.67.5)
- Microsoft.DocAsCode.YamlSerialization (>= 2.67.5)
- Stubble.Core (>= 1.10.8)
NuGet 包 (1)
显示依赖于 Microsoft.DocAsCode.Build.Engine 的顶级 1 个 NuGet 包
包 | 下载 |
---|---|
Microsoft.DocAsCode.App Docfx 发布为库以进行扩展和高级自定义 |
GitHub 仓库
此软件包没有被任何流行的GitHub仓库使用。
版本 | 下载 | 最后更新 | |
---|---|---|---|
2.67.5 | 8,428 | 6/21/2023 | |
2.67.3 | 1,569 | 6/2/2023 | |
2.67.2 | 438 | 5/26/2023 | |
2.67.1 | 498 | 5/16/2023 | |
2.67.0 | 855 | 5/6/2023 | |
2.66.2 | 4,673 | 4/26/2023 | |
2.66.1 | 1,386 | 4/25/2023 | |
2.66.0 | 392 | 4/24/2023 | |
2.65.3 | 456 | 4/14/2023 | |
2.65.2 | 395 | 4/11/2023 | |
2.65.1 | 325 | 4/9/2023 | |
2.65.0 | 412 | 4/7/2023 | |
2.64.0 | 537 | 3/30/2023 | |
2.63.1 | 650 | 3/21/2023 | |
2.63.0 | 420 | 3/20/2023 | |
2.62.2 | 487 | 3/7/2023 | |
2.62.1 | 1,864 | 2/15/2023 | |
2.62.0 | 383 | 2/14/2023 | |
2.61.0 | 2,373 | 1/30/2023 | |
2.60.2 | 819 | 1/20/2023 | |
2.60.1 | 470 | 1/18/2023 | |
2.60.0 | 921 | 1/13/2023 | |
2.60.0-preview.2 | 131 | 12/25/2022 | |
2.60.0-preview.1 | 124 | 12/20/2022 | |
2.59.4 | 6,342 | 9/7/2022 | |
2.59.3 | 1,122 | 7/6/2022 | |
2.59.2 | 1,077 | 4/11/2022 | |
2.59.1 | 704 | 3/31/2022 | |
2.59.0 | 3,097 | 1/19/2022 | |
2.58.9 | 747 | 11/4/2021 | |
2.58.8 | 547 | 11/1/2021 | |
2.58.5 | 543 | 10/26/2021 | |
2.58.4 | 585 | 9/14/2021 | |
2.58.3 | 544 | 9/7/2021 | |
2.58.2 | 561 | 8/24/2021 | |
2.58.1 | 536 | 8/23/2021 | |
2.58.0 | 751 | 6/9/2021 | |
2.57.2 | 682 | 4/14/2021 | |
2.57.1 | 560 | 4/13/2021 | |
2.57.0 | 579 | 4/9/2021 | |
2.56.7 | 1,712 | 3/2/2021 | |
2.56.6 | 1,438 | 12/10/2020 | |
2.56.5 | 706 | 11/10/2020 | |
2.56.4 | 717 | 10/20/2020 | |
2.56.3 | 699 | 10/12/2020 | |
2.56.2 | 908 | 7/27/2020 | |
2.56.1 | 762 | 7/6/2020 | |
2.56.0 | 770 | 6/29/2020 | |
2.55.0 | 884 | 6/12/2020 | |
2.54.0 | 853 | 6/4/2020 | |
2.53.1 | 960 | 5/11/2020 | |
2.52.0 | 1,110 | 4/13/2020 | |
2.51.0 | 3,078 | 3/20/2020 | |
2.50.0 | 1,083 | 3/2/2020 | |
2.49.0 | 934 | 2/17/2020 | |
2.48.1 | 2,285 | 1/13/2020 | |
2.48.0 | 1,775 | 12/9/2019 | |
2.47.0 | 1,372 | 10/31/2019 | |
2.46.0 | 1,492 | 10/14/2019 | |
2.45.1 | 3,217 | 9/15/2019 | |
2.45.0 | 1,322 | 8/25/2019 | |
2.44.0 | 2,008 | 8/2/2019 | |
2.43.2 | 2,201 | 7/2/2019 | |
2.43.1 | 1,316 | 6/14/2019 | |
2.42.4 | 2,078 | 5/24/2019 | |
2.42.3 | 13,487 | 5/13/2019 | |
2.42.2 | 1,138 | 5/10/2019 | |
2.42.0 | 1,216 | 4/22/2019 | |
2.41.0 | 3,244 | 3/29/2019 | |
2.40.12 | 1,156 | 3/11/2019 | |
2.40.11 | 2,386 | 2/16/2019 | |
2.40.10 | 1,320 | 2/1/2019 | |
2.40.9 | 1,408 | 1/31/2019 | |
2.40.8 | 1,427 | 1/25/2019 | |
2.40.7 | 1,282 | 1/4/2019 | |
2.40.5 | 1,288 | 12/19/2018 | |
2.40.4 | 1,259 | 11/26/2018 | |
2.40.2 | 1,351 | 11/7/2018 | |
2.40.1 | 1,305 | 10/29/2018 | |
2.40.0 | 1,316 | 10/12/2018 | |
2.39.2 | 2,839 | 9/9/2018 | |
2.39.1 | 2,772 | 9/4/2018 | |
2.39.0 | 5,848 | 9/2/2018 | |
2.38.1 | 6,112 | 8/16/2018 | |
2.38.0 | 1,522 | 8/13/2018 | |
2.37.2 | 1,388 | 7/31/2018 | |
2.37.1 | 1,692 | 7/31/2018 | |
2.36.2 | 1,620 | 6/13/2018 | |
2.36.1 | 1,536 | 5/25/2018 | |
2.36.0 | 1,547 | 5/21/2018 | |
2.36.0-alpha-0159-g25e5900b4 | 958 | 4/26/2018 | |
2.35.4 | 1,505 | 5/2/2018 | |
2.35.3 | 1,578 | 5/2/2018 | |
2.35.0-alpha-0153-g6da267dd4 | 964 | 4/25/2018 | |
2.33.2 | 1,887 | 4/3/2018 | |
2.33.1 | 1,428 | 4/3/2018 | |
2.33.0 | 1,435 | 3/19/2018 | |
2.32.2 | 1,601 | 3/12/2018 | |
2.32.0 | 1,472 | 2/28/2018 | |
2.31.0 | 1,630 | 2/5/2018 | |
2.30.0 | 1,688 | 1/12/2018 | |
2.29.1 | 1,759 | 12/29/2017 | |
2.28.3 | 1,445 | 12/14/2017 | |
2.28.2 | 1,592 | 12/7/2017 | |
2.28.1 | 1,580 | 12/1/2017 | |
2.28.0 | 1,506 | 11/30/2017 | |
2.27.0 | 1,499 | 11/21/2017 | |
2.26.3 | 1,675 | 10/26/2017 | |
2.26.1 | 1,512 | 10/24/2017 | |
2.26.0 | 1,471 | 10/23/2017 | |
2.25.1 | 1,484 | 10/9/2017 | |
2.25.0 | 1,678 | 10/9/2017 | |
2.24.0 | 1,566 | 9/11/2017 | |
2.23.1 | 1,476 | 8/22/2017 | |
2.22.3 | 1,456 | 8/17/2017 | |
2.22.1 | 1,473 | 8/2/2017 | |
2.22.0 | 1,496 | 8/1/2017 | |
2.21.2 | 1,504 | 7/26/2017 | |
2.21.1 | 1,632 | 7/17/2017 | |
2.20.0 | 1,524 | 7/12/2017 | |
2.19.2 | 1,661 | 6/29/2017 | |
2.18.5 | 1,554 | 6/15/2017 | |
2.18.4 | 1,574 | 6/9/2017 | |
2.18.3 | 1,555 | 6/8/2017 | |
2.18.1 | 1,490 | 5/31/2017 | |
2.17.5 | 1,492 | 5/23/2017 | |
2.17.3 | 1,545 | 5/11/2017 | |
2.17.2 | 1,536 | 5/9/2017 | |
2.16.8 | 1,751 | 5/3/2017 | |
2.16.7 | 1,556 | 4/26/2017 | |
2.16.5 | 1,524 | 4/25/2017 | |
2.16.2 | 1,598 | 4/20/2017 | |
2.16.0 | 1,515 | 4/17/2017 | |
2.15.5 | 1,987 | 4/6/2017 | |
2.15.2 | 1,961 | 3/29/2017 | |
2.13.1 | 1,903 | 3/7/2017 | |
2.13.0 | 2,016 | 3/6/2017 | |
2.12.1 | 2,055 | 2/14/2017 | |
2.12.0 | 1,973 | 2/13/2017 | |
2.11.3 | 1,904 | 2/7/2017 | |
2.11.2 | 1,836 | 1/25/2017 | |
2.11.1 | 1,851 | 1/24/2017 | |
2.11.0 | 1,909 | 1/23/2017 | |
2.10.2 | 1,932 | 1/4/2017 | |
2.10.1 | 2,130 | 1/4/2017 | |
2.10.0 | 2,262 | 1/3/2017 | |
2.9.3 | 1,925 | 12/15/2016 | |
2.9.2 | 1,935 | 12/14/2016 | |
2.9.1 | 1,960 | 12/13/2016 | |
2.9.0 | 1,949 | 12/12/2016 | |
2.8.2 | 1,964 | 11/28/2016 | |
2.8.1 | 1,950 | 11/24/2016 | |
2.8.0 | 2,070 | 11/22/2016 | |
2.7.3 | 2,243 | 11/8/2016 | |
2.7.2 | 2,143 | 11/3/2016 | |
2.7.1 | 2,210 | 11/1/2016 | |
2.7.0 | 1,943 | 10/31/2016 | |
2.6.3 | 1,972 | 10/25/2016 | |
2.6.1 | 1,899 | 10/11/2016 | |
2.6.0 | 1,916 | 10/10/2016 | |
2.5.4 | 2,463 | 9/22/2016 | |
2.5.3 | 2,280 | 9/20/2016 | |
2.5.2 | 2,134 | 9/19/2016 | |
2.5.1 | 2,166 | 9/19/2016 | |
2.5.0 | 1,906 | 9/14/2016 | |
2.4.0 | 1,813 | 8/29/2016 | |
2.3.1 | 1,723 | 8/22/2016 | |
2.3.0 | 1,877 | 8/8/2016 | |
2.2.2 | 1,892 | 7/22/2016 | |
2.2.1 | 1,741 | 7/19/2016 | |
2.2.0 | 1,791 | 7/18/2016 | |
2.1.0 | 1,879 | 6/27/2016 | |
2.0.2 | 1,763 | 6/22/2016 | |
2.0.1 | 1,864 | 6/7/2016 | |
2.0.0 | 1,782 | 6/6/2016 | |
1.9.4 | 2,146 | 5/19/2016 | |
1.9.3 | 1,832 | 5/19/2016 | |
1.9.0 | 1,841 | 5/16/2016 | |
1.8.4 | 1,827 | 5/10/2016 | |
1.8.1 | 1,809 | 5/4/2016 | |
1.8.0 | 1,979 | 4/25/2016 | |
1.7.2 | 1,815 | 4/20/2016 | |
1.7.1 | 1,816 | 4/7/2016 | |
1.7.0 | 2,025 | 4/6/2016 |