Docfx.DataContracts.RestApi 2.77.0
前缀已保留
dotnet add package Docfx.DataContracts.RestApi --version 2.77.0
NuGet\Install-Package Docfx.DataContracts.RestApi -Version 2.77.0
<PackageReference Include="Docfx.DataContracts.RestApi" Version="2.77.0" />
paket add Docfx.DataContracts.RestApi --version 2.77.0
#r "nuget: Docfx.DataContracts.RestApi, 2.77.0"
// Install Docfx.DataContracts.RestApi as a Cake Addin #addin nuget:?package=Docfx.DataContracts.RestApi&version=2.77.0 // Install Docfx.DataContracts.RestApi as a Cake Tool #tool nuget:?package=Docfx.DataContracts.RestApi&version=2.77.0
使用 docfx 构建您的文档
使用 docfx 构建您的技术文献站点,包括首页、Markdown、.NET、REST 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 Releases。鼓励使用常规提交。
Docfx不是按照常规节奏发布的,新版本会在维护者认为有足够的变化需要进行新发布时推出。有时我们使用预发布版来自我测试破坏性变更并从社区获得反馈。
路线图
我们使用里程碑来沟通即将到来的Docfx更改。
许可协议
该项目根据MIT许可证授权。
.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.Common (>= 2.77.0)
- Docfx.DataContracts.Common (>= 2.77.0)
- Docfx.YamlSerialization (>= 2.77.0)
-
net8.0
- Docfx.Common (>= 2.77.0)
- Docfx.DataContracts.Common (>= 2.77.0)
- Docfx.YamlSerialization (>= 2.77.0)
NuGet 包 (3)
显示依赖于 Docfx.DataContracts.RestApi 的前 3 个 NuGet 包
包 | 下载 |
---|---|
Docfx.Build.RestApi 包含 markdown、.NET、REST API 等技术文档工具的文档编写工具。 |
|
Docfx.Build.OperationLevelRestApi 包含 markdown、.NET、REST API 等技术文档工具的文档编写工具。 |
|
Docfx.Build.TagLevelRestApi 包含 markdown、.NET、REST API 等技术文档工具的文档编写工具。 |
GitHub仓库
此包未被任何流行GitHub仓库使用。
版本 | 下载 | 最后更新 |
---|---|---|
2.77.0 | 988 | 7/1/2024 |
2.76.0 | 3,763 | 4/7/2024 |
2.75.3 | 2,694 | 2/18/2024 |
2.75.2 | 2,078 | 1/27/2024 |
2.75.1 | 3,066 | 1/13/2024 |
2.75.0 | 1,231 | 1/12/2024 |
2.74.1 | 1,114 | 11/30/2023 |
2.74.0 | 932 | 11/20/2023 |
2.73.2 | 1,401 | 11/13/2023 |
2.73.1 | 217 | 11/7/2023 |
2.73.0 | 267 | 11/2/2023 |
2.72.1 | 227 | 10/28/2023 |
2.72.0 | 282 | 10/24/2023 |
2.71.1 | 763 | 10/18/2023 |
2.71.0 | 490 | 9/30/2023 |
2.70.4 | 345 | 9/18/2023 |
2.70.3 | 239 | 9/5/2023 |
2.70.2 | 200 | 9/4/2023 |
2.70.1 | 387 | 9/4/2023 |
2.70.0 | 1,263 | 7/29/2023 |