Docfx.YamlSerialization 2.77.0
前缀已保留
dotnet add package Docfx.YamlSerialization --version 2.77.0
NuGet\Install-Package Docfx.YamlSerialization -Version 2.77.0
<PackageReference Include="Docfx.YamlSerialization" Version="2.77.0" />
paket add Docfx.YamlSerialization --version 2.77.0
#r "nuget: Docfx.YamlSerialization, 2.77.0"
// Install Docfx.YamlSerialization as a Cake Addin #addin nuget:?package=Docfx.YamlSerialization&version=2.77.0 // Install Docfx.YamlSerialization as a Cake Tool #tool nuget:?package=Docfx.YamlSerialization&version=2.77.0
使用docfx构建您的文档
使用docfx构建您的技术文档网站,包含着陆页、Markdown、.NET、REST API等API参考文档。
正如您所听说的,docfx已过渡为.NET Foundation项目。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查看示例网站。
有关更多信息,请参阅入门指南。
【提示】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 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
- YamlDotNet (>= 15.3.0)
-
net8.0
- YamlDotNet (>= 15.3.0)
NuGet 包 (11)
显示依赖于 Docfx.YamlSerialization 的前 5 个 NuGet 包
包 | 下载 |
---|---|
Docfx.Common 带有 markdown、.NET API 文档、REST API 等技术文档工具。 |
|
Docfx.Build.Common 带有 markdown、.NET API 文档、REST API 等技术文档工具。 |
|
Docfx.Dotnet 带有 markdown、.NET API 文档、REST API 等技术文档工具。 |
|
Docfx.MarkdigEngine 带有 markdown、.NET API 文档、REST API 等技术文档工具。 |
|
Docfx.Build.ManagedReference 带有 markdown、.NET API 文档、REST API 等技术文档工具。 |
GitHub 仓库
此包未在任何流行的GitHub仓库中使用。
版本 | 下载 | 最后更新时间 |
---|---|---|
2.77.0 | 1,530 | 7/1/2024 |
2.76.0 | 5,303 | 4/7/2024 |
2.75.3 | 3,361 | 2/18/2024 |
2.75.2 | 5,296 | 1/27/2024 |
2.75.1 | 3,310 | 1/13/2024 |
2.75.0 | 1,375 | 1/12/2024 |
2.74.1 | 2,082 | 11/30/2023 |
2.74.0 | 1,118 | 11/20/2023 |
2.73.2 | 1,749 | 11/13/2023 |
2.73.1 | 388 | 11/7/2023 |
2.73.0 | 703 | 11/2/2023 |
2.72.1 | 376 | 10/28/2023 |
2.72.0 | 448 | 10/24/2023 |
2.71.1 | 949 | 10/18/2023 |
2.71.0 | 688 | 9/30/2023 |
2.70.4 | 522 | 9/18/2023 |
2.70.3 | 1,420 | 9/5/2023 |
2.70.2 | 400 | 9/4/2023 |
2.70.1 | 570 | 9/4/2023 |
2.70.0 | 1,584 | 7/29/2023 |