Microsoft.DocAsCode.Build.OverwriteDocuments 2.67.5
前缀已保留
Docfx.Build.OverwriteDocuments
详细信息由于Docfx已完全转型为完全由社区为社区利益所推动的.NET Foundation项目,因此我们正在将NuGet包名、程序集名和命名空间名从Microsoft.DocAsCode.*更改为Docfx.*。
dotnet add package Microsoft.DocAsCode.Build.OverwriteDocuments --version 2.67.5
NuGet\Install-Package Microsoft.DocAsCode.Build.OverwriteDocuments -Version 2.67.5
<PackageReference Include="Microsoft.DocAsCode.Build.OverwriteDocuments" Version="2.67.5" />
paket add Microsoft.DocAsCode.Build.OverwriteDocuments --version 2.67.5
#r "nuget: Microsoft.DocAsCode.Build.OverwriteDocuments, 2.67.5"
// Install Microsoft.DocAsCode.Build.OverwriteDocuments as a Cake Addin #addin nuget:?package=Microsoft.DocAsCode.Build.OverwriteDocuments&version=2.67.5 // Install Microsoft.DocAsCode.Build.OverwriteDocuments as a Cake Tool #tool nuget:?package=Microsoft.DocAsCode.Build.OverwriteDocuments&version=2.67.5
使用docfx生成您的文档
使用docfx构建您的技术文档网站,包括登录页面、markdown、.NET、REST API等API参考文档。
⚠️⚠️⚠️ 注意 ⚠️⚠️⚠️
DocFX正在过渡到.NET Foundation,成为官方.NET项目!
- DocFX团队正在改进主线,这将向项目引入新功能和错误修复,移除一些不再必要的较旧代码和功能,以及更新依赖关系和简化项目结构。请关注路线图。
- 由于网站架构调整(请参阅相关讨论),DocFX不再支持直接构建Microsoft Learn内容。持Markdown内容的开源仓库将仍然接受拉动请求和更改,但是不能直接使用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查看示例网站。
有关更多信息,请参阅入门简介。
贡献
使用讨论提问和进行一般讨论。使用问题报告错误和提出功能建议。
我们欢迎通过拉动请求进行代码贡献。标记为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
分支是拉动请求和大多数其他开发活动的默认分支。我们偶尔会使用feature/*
分支进行史诗级功能开发。
发布基于稳定的main
分支提交,使用GitHub Releases。鼓励使用常规提交。
Docfx不是按照常规节奏发布,只有维护者认为有足够的变化需要新的发布时,才会出现新版本。有时我们使用预发布版来测试破坏性更改并从社区获得反馈。
路线图
我们使用里程碑来传达即将进行的变化。
许可
本项目采用MIT许可证。
.NET Foundation
本项目由.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
- Markdig (>= 0.31.0)
- Microsoft.DocAsCode.Build.Common (>= 2.67.5)
-
net7.0
- Markdig (>= 0.31.0)
- Microsoft.DocAsCode.Build.Common (>= 2.67.5)
-
net8.0
- Markdig (>= 0.31.0)
- Microsoft.DocAsCode.Build.Common (>= 2.67.5)
NuGet包 (1)
显示最依赖Microsoft.DocAsCode.Build.OverwriteDocuments的1个NuGet包
包 | 下载 |
---|---|
Microsoft.DocAsCode.Build.SchemaDriven 包描述 |
GitHub仓库
此包未在任何流行的GitHub仓库中使用。
版本 | 下载 | 最后更新 | |
---|---|---|---|
2.67.5 | 8,622 | 6/21/2023 | |
2.67.3 | 1,641 | 6/2/2023 | |
2.67.2 | 481 | 5/26/2023 | |
2.67.1 | 523 | 5/16/2023 | |
2.67.0 | 929 | 5/6/2023 | |
2.66.2 | 4,744 | 4/26/2023 | |
2.66.1 | 1,420 | 4/25/2023 | |
2.66.0 | 446 | 4/24/2023 | |
2.65.3 | 500 | 4/14/2023 | |
2.65.2 | 473 | 4/11/2023 | |
2.65.1 | 419 | 4/9/2023 | |
2.65.0 | 459 | 4/7/2023 | |
2.64.0 | 594 | 3/30/2023 | |
2.63.1 | 727 | 3/21/2023 | |
2.63.0 | 501 | 3/20/2023 | |
2.62.2 | 568 | 3/7/2023 | |
2.62.1 | 1,978 | 2/15/2023 | |
2.62.0 | 499 | 2/14/2023 | |
2.61.0 | 2,480 | 1/30/2023 | |
2.60.2 | 962 | 1/20/2023 | |
2.60.1 | 614 | 1/18/2023 | |
2.60.0 | 1,078 | 1/13/2023 | |
2.60.0-preview.2 | 154 | 12/25/2022 | |
2.60.0-preview.1 | 135 | 12/20/2022 | |
2.59.4 | 6,508 | 9/7/2022 | |
2.59.3 | 1,359 | 7/6/2022 | |
2.59.2 | 1,352 | 4/11/2022 | |
2.59.1 | 1,059 | 3/31/2022 | |
2.59.0 | 3,454 | 1/19/2022 | |
2.58.9 | 1,057 | 11/4/2021 | |
2.58.8 | 669 | 11/1/2021 | |
2.58.5 | 664 | 10/26/2021 | |
2.58.4 | 784 | 9/14/2021 | |
2.58.3 | 680 | 9/7/2021 | |
2.58.2 | 746 | 8/24/2021 | |
2.58.1 | 726 | 8/23/2021 | |
2.58.0 | 928 | 6/9/2021 | |
2.57.2 | 862 | 4/14/2021 | |
2.57.1 | 725 | 4/13/2021 | |
2.57.0 | 743 | 4/9/2021 | |
2.56.7 | 1,833 | 3/2/2021 | |
2.56.6 | 1,572 | 12/10/2020 | |
2.56.5 | 880 | 11/10/2020 | |
2.56.4 | 2,777 | 10/20/2020 | |
2.56.3 | 831 | 10/12/2020 | |
2.56.2 | 1,070 | 7/27/2020 | |
2.56.1 | 971 | 7/6/2020 | |
2.56.0 | 951 | 6/29/2020 | |
2.55.0 | 1,015 | 6/12/2020 | |
2.53.1 | 1,036 | 5/11/2020 | |
2.52.0 | 1,158 | 4/13/2020 | |
2.51.0 | 3,479 | 3/20/2020 | |
2.50.0 | 1,129 | 3/2/2020 | |
2.49.0 | 1,037 | 2/17/2020 | |
2.48.1 | 2,542 | 1/13/2020 | |
2.48.0 | 1,587 | 12/9/2019 | |
2.47.0 | 1,238 | 10/31/2019 | |
2.46.0 | 1,346 | 10/14/2019 | |
2.45.1 | 3,049 | 9/15/2019 | |
2.45.0 | 1,142 | 8/25/2019 | |
2.44.0 | 1,810 | 8/2/2019 | |
2.43.2 | 1,678 | 7/2/2019 | |
2.43.1 | 896 | 6/14/2019 | |
2.42.4 | 1,533 | 5/24/2019 | |
2.42.3 | 13,057 | 5/13/2019 | |
2.42.2 | 720 | 5/10/2019 | |
2.42.0 | 782 | 4/22/2019 | |
2.41.0 | 2,809 | 3/29/2019 | |
2.40.12 | 779 | 3/11/2019 | |
2.40.11 | 1,951 | 2/16/2019 | |
2.40.10 | 931 | 2/1/2019 | |
2.40.9 | 960 | 1/31/2019 | |
2.40.8 | 946 | 1/25/2019 | |
2.40.7 | 874 | 1/4/2019 | |
2.40.5 | 903 | 12/19/2018 | |
2.40.4 | 849 | 11/26/2018 | |
2.40.2 | 874 | 11/7/2018 | |
2.40.1 | 852 | 10/29/2018 | |
2.40.0 | 917 | 10/12/2018 | |
2.39.2 | 2,414 | 9/9/2018 | |
2.39.1 | 2,276 | 9/4/2018 | |
2.39.0 | 5,436 | 9/2/2018 | |
2.38.1 | 5,689 | 8/16/2018 | |
2.38.0 | 1,130 | 8/13/2018 | |
2.37.2 | 991 | 7/31/2018 | |
2.37.1 | 1,259 | 7/31/2018 | |
2.36.2 | 1,233 | 6/13/2018 | |
2.36.1 | 1,048 | 5/25/2018 | |
2.36.0 | 1,105 | 5/21/2018 | |
2.36.0-alpha-0159-g25e5900b4 | 890 | 4/26/2018 | |
2.35.4 | 1,172 | 5/2/2018 | |
2.35.3 | 1,206 | 5/2/2018 | |
2.35.0-alpha-0153-g6da267dd4 | 871 | 4/26/2018 |