Docfx.Build.TagLevelRestApi 2.77.0
前缀已保留
dotnet add package Docfx.Build.TagLevelRestApi --version 2.77.0
NuGet\Install-Package Docfx.Build.TagLevelRestApi -Version 2.77.0
<PackageReference Include="Docfx.Build.TagLevelRestApi" Version="2.77.0" />
paket add Docfx.Build.TagLevelRestApi --version 2.77.0
#r "nuget: Docfx.Build.TagLevelRestApi, 2.77.0"
// Install Docfx.Build.TagLevelRestApi as a Cake Addin #addin nuget:?package=Docfx.Build.TagLevelRestApi&version=2.77.0 // Install Docfx.Build.TagLevelRestApi as a Cake Tool #tool nuget:?package=Docfx.Build.TagLevelRestApi&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的最新发展。
贡献
使用讨论进行提问和一般讨论。使用问题来报告bug以及建议新功能。
我们欢迎通过拉取请求贡献代码,标记为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 Releases。鼓励使用Conventional Commit。
Docfx不是按照常规时间表发布,版本更新是当维护者认为有足够的变化值得发布新版本时发生的。有时我们使用 предварительные выпуски,以便在内部测试 breaking changes 并从社区获取反馈。
路线图
我们使用里程碑来传达即将到来的Docfx更改。
许可协议
本项目根据MIT许可证授权。
.NET 基金会
本项目由.NET基金会支持。
本项目已采用.NET基金会行为规范定义的行为规范,以阐明我们社区中预期的行为。有关更多信息,请参阅.NET基金会行为规范。
产品 | 版本 兼容和额外的计算目标框架版本。 |
---|---|
.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)
- Docfx.Common (>= 2.77.0)
- Docfx.DataContracts.RestApi (>= 2.77.0)
- Docfx.Plugins (>= 2.77.0)
-
net8.0
- Docfx.Build.Common (>= 2.77.0)
- Docfx.Common (>= 2.77.0)
- Docfx.DataContracts.RestApi (>= 2.77.0)
- Docfx.Plugins (>= 2.77.0)
NuGet包
此包未被任何NuGet包使用。
GitHub仓库
此包未被任何流行的GitHub仓库使用。
版本 | 下载 | 最后更新 |
---|---|---|
2.77.0 | 116 | 7/1/2024 |
2.76.0 | 119 | 4/7/2024 |
2.75.3 | 152 | 2/18/2024 |
2.75.2 | 106 | 1/27/2024 |
2.75.1 | 150 | 1/13/2024 |
2.75.0 | 92 | 1/12/2024 |
2.74.1 | 181 | 11/30/2023 |
2.74.0 | 101 | 11/20/2023 |
2.73.2 | 105 | 11/13/2023 |
2.73.1 | 99 | 11/7/2023 |
2.73.0 | 112 | 11/2/2023 |
2.72.1 | 103 | 10/28/2023 |
2.72.0 | 118 | 10/24/2023 |
2.71.1 | 110 | 10/18/2023 |
2.71.0 | 116 | 9/30/2023 |
2.70.4 | 109 | 9/18/2023 |
2.70.3 | 123 | 9/5/2023 |
2.70.2 | 112 | 9/4/2023 |
2.70.1 | 110 | 9/4/2023 |
2.70.0 | 167 | 7/29/2023 |