Docfx.Build.OverwriteDocuments 2.77.0
前缀已保留
dotnet add package Docfx.Build.OverwriteDocuments --version 2.77.0
NuGet\Install-Package Docfx.Build.OverwriteDocuments -Version 2.77.0
<PackageReference Include="Docfx.Build.OverwriteDocuments" Version="2.77.0" />
paket add Docfx.Build.OverwriteDocuments --version 2.77.0
#r "nuget: Docfx.Build.OverwriteDocuments, 2.77.0"
// Install Docfx.Build.OverwriteDocuments as a Cake Addin #addin nuget:?package=Docfx.Build.OverwriteDocuments&version=2.77.0 // Install Docfx.Build.OverwriteDocuments as a Cake Tool #tool nuget:?package=Docfx.Build.OverwriteDocuments&version=2.77.0
使用 docfx 创建您的文档
使用 docfx 构建技术文档站点,包括起始页、Markdown、.NET、REST API 的 API 参考文档等。
如您所知,docfx 已转为 .NET 基金会项目。Microsoft Learn 不会再用 docfx,并且从 2022 年 11 月起不再支持该项目。
docfx 计划继续作为社区驱动的项目。我们希望产生包含新特性和增强功能的未来版本,以支持现有和新用例。我们也希望邀请任何感兴趣的一方参与此项目。如果您想联系社区团队,请打开一个讨论线程。
入门指南
将 docfx 安装为全局工具
dotnet tool install -g docfx
创建并启动本地站点
docfx init -y docfx build docfx_project\docfx.json --serve
转到 https://127.0.0.1:8080 查看示例站点。
有关更多信息,请参阅 入门指南。
[!TIP] Docfx 将夜间构建发布到 GitHub Packages,这允许您跟踪 Docfx 的最新发展。
贡献
如有问题或进行一般性讨论,请使用 讨论。如有错误报告或功能建议,请使用 问题。
我们欢迎通过拉取请求进行代码贡献。问题中标注有 help-wanted
的属于代码贡献的良好开端。
先决条件
- 安装 Visual Studio 2022 (社区或更高版本) 并确保您拥有最新的更新。
- 安装 .NET SDK 6.x 和 8.x。
- 安装 NodeJS (20.x.x)。
构建和测试
- 在
templates
目录中构建站点模板- 运行
npm install
以还原 npm 依赖项。 - 运行
npm run build
以构建模板。
- 运行
- 运行
dotnet build
以构建项目或使用 Visual Studio 构建项目docfx.sln
。 - 运行
dotnet test
以测试项目或使用 Visual Studio 测试资源管理器。- 运行
git lfs checkout
进行快照测试的文件签出
- 运行
分支和发布
main
分支是用于拉取请求和大多数其他开发活动的默认分支。我们偶尔会使用 feature/*
分支进行史诗功能开发。
发布基于稳定的 main
分支提交,使用 GitHub 发布。鼓励使用 常规提交。
Docfx 不 按固定节奏发布,新版本将在维护者认为足够的更改值得新版本发布时推出。有时我们使用预发布版来尝试验证破坏性更改并从社区获得反馈。
路线图
我们使用 里程碑 来宣布即将到来的 Docfx 变更。
许可
此项目受 MIT 许可证的许可。
.NET 基金会
此项目由 .NET 基金会 支持。
此项目采用了 by Contributor Covenant 定义的 Code of Conduct,以阐明我们社区中期望的行为。有关更多信息,请参阅 .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
- Docfx.Build.Common (>= 2.77.0)
- Markdig (>= 0.37.0)
-
net8.0
- Docfx.Build.Common (>= 2.77.0)
- Markdig (>= 0.37.0)
NuGet 包 (1)
显示依赖于 Docfx.Build.OverwriteDocuments 的前 1 个 NuGet 包
包 | 下载 |
---|---|
Docfx.Build.SchemaDriven 带 Markdown、.NET、REST API 等 API 文档的技术文档工具。 |
GitHub 仓库
此包未被任何流行的 GitHub 仓库使用。
版本 | 下载 | 最后更新 |
---|---|---|
2.77.0 | 961 | 7/1/2024 |
2.76.0 | 3,768 | 4/7/2024 |
2.75.3 | 2,658 | 2/18/2024 |
2.75.2 | 5,023 | 1/27/2024 |
2.75.1 | 3,044 | 1/13/2024 |
2.75.0 | 1,224 | 1/12/2024 |
2.74.1 | 1,100 | 11/30/2023 |
2.74.0 | 893 | 11/20/2023 |
2.73.2 | 1,333 | 11/13/2023 |
2.73.1 | 200 | 11/7/2023 |
2.73.0 | 252 | 11/2/2023 |
2.72.1 | 206 | 10/28/2023 |
2.72.0 | 261 | 10/24/2023 |
2.71.1 | 738 | 10/18/2023 |
2.71.0 | 475 | 9/30/2023 |
2.70.4 | 334 | 9/18/2023 |
2.70.3 | 225 | 9/5/2023 |
2.70.2 | 182 | 9/4/2023 |
2.70.1 | 371 | 9/4/2023 |
2.70.0 | 1,270 | 7/29/2023 |