Docfx.Build.OperationLevelRestApi 2.77.0

前缀已预留
dotnet add package Docfx.Build.OperationLevelRestApi --version 2.77.0                
NuGet\Install-Package Docfx.Build.OperationLevelRestApi -Version 2.77.0                
此命令旨在在 Visual Studio 的包管理器控制台中使用,因为它使用 NuGet 模块的版本 Install-Package.
<PackageReference Include="Docfx.Build.OperationLevelRestApi" Version="2.77.0" />                
对于支持 PackageReference 的项目,请将此 XML 节点复制到项目文件中以引用此包。
paket add Docfx.Build.OperationLevelRestApi --version 2.77.0                
#r "nuget: Docfx.Build.OperationLevelRestApi, 2.77.0"                
#r 指令可用于 F# 交互式和Polyglot Notebooks。将此复制到交互式工具或脚本的源代码中以引用包。
// Install Docfx.Build.OperationLevelRestApi as a Cake Addin
#addin nuget:?package=Docfx.Build.OperationLevelRestApi&version=2.77.0

// Install Docfx.Build.OperationLevelRestApi as a Cake Tool
#tool nuget:?package=Docfx.Build.OperationLevelRestApi&version=2.77.0                

使用 docfx 构建您的文档

NuGet Help Wanted

使用 docfx 构建您的技术文档网站,包括着陆页、Markdown、.NET、REST API 等的 API 参考文档。


如您所知,docfx 已转换为 .NET 基金会项目。Microsoft Learn 不再使用 docfx,并且自 2022 年 11 月起不打算支持该项目。

docfx 计划继续作为一个社区驱动的项目。我们希望能够以新特性和改进来支持现有和新用例的未来版本。我们还希望邀请任何有兴趣的各方参与此项目。如果您想联系社区团队,请打开一个讨论主题。

入门指南

  1. 将 docfx 安装为全局工具

    dotnet tool install -g docfx
    
  2. 创建并本地启动网站

    docfx init -y
    docfx build docfx_project\docfx.json --serve
    
  3. 转到 https://127.0.0.1:8080 查看示例网站。

更多信息,请参阅入门指南

[!TIP] Docfx每天晚上将构建版本发布到GitHub Packages,这使您能够及时了解Docfx的最新进展。

参与贡献

对于问题和一般讨论,请使用讨论区。要报告错误和提议新功能,请使用问题跟踪

我们欢迎通过pull请求进行代码贡献,标签为`help-wanted`的问题很合适开始贡献代码。

先决条件

构建和测试

  • templates目录中构建网站模板
    • 运行npm install以恢复npm依赖项。
    • 运行npm run build以构建模板。
  • 运行dotnet build以构建项目或使用Visual Studio构建docfx.sln
  • 运行dotnet test以测试项目或使用Visual Studio测试资源管理器。
    • 运行git lfs checkout以检出用于快照测试的文件。

分支和版本发布

main分支是pull请求和大多数其他开发活动的默认分支。我们偶尔会使用feature/*分支进行史诗功能开发。

版本发布基于稳定的main分支提交,使用GitHub版本发布。鼓励使用常规提交

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 已计算。
兼容的目标框架
包含的目标框架(在包中)
了解有关目标框架.NET Standard的更多信息。

NuGet 包

此包未由任何 NuGet 包使用。

GitHub 仓库

此包未由任何流行的 GitHub 仓库使用。

版本 下载 最后更新
2.77.0 78 7/1/2024
2.76.0 97 4/7/2024
2.75.3 142 2/18/2024
2.75.2 105 1/27/2024
2.75.1 114 1/13/2024
2.75.0 93 1/12/2024
2.74.1 197 11/30/2023
2.74.0 112 11/20/2023
2.73.2 99 11/13/2023
2.73.1 110 11/7/2023
2.73.0 111 11/2/2023
2.72.1 130 10/28/2023
2.72.0 123 10/24/2023
2.71.1 100 10/18/2023
2.71.0 126 9/30/2023
2.70.4 113 9/18/2023
2.70.3 144 9/5/2023
2.70.2 147 9/4/2023
2.70.1 118 9/4/2023
2.70.0 176 7/29/2023