Docfx.Build.ManagedReference 2.77.0
前缀已预留
dotnet add package Docfx.Build.ManagedReference --version 2.77.0
NuGet\Install-Package Docfx.Build.ManagedReference -Version 2.77.0
<PackageReference Include="Docfx.Build.ManagedReference" Version="2.77.0" />
paket add Docfx.Build.ManagedReference --version 2.77.0
#r "nuget: Docfx.Build.ManagedReference, 2.77.0"
// Install Docfx.Build.ManagedReference as a Cake Addin #addin nuget:?package=Docfx.Build.ManagedReference&version=2.77.0 // Install Docfx.Build.ManagedReference as a Cake Tool #tool nuget:?package=Docfx.Build.ManagedReference&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 以查看示例网站。
有关更多信息,请参阅 入门。
[!提示] 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.Build.Common (>= 2.77.0)
- Docfx.Common (>= 2.77.0)
- Docfx.DataContracts.Common (>= 2.77.0)
- Docfx.Dotnet (>= 2.77.0)
- Docfx.Plugins (>= 2.77.0)
- Docfx.YamlSerialization (>= 2.77.0)
-
net8.0
- Docfx.Build.Common (>= 2.77.0)
- Docfx.Common (>= 2.77.0)
- Docfx.DataContracts.Common (>= 2.77.0)
- Docfx.Dotnet (>= 2.77.0)
- Docfx.Plugins (>= 2.77.0)
- Docfx.YamlSerialization (>= 2.77.0)
NuGet 包 (1)
显示依赖 Docfx.Build.ManagedReference 的前 1 个 NuGet 包
包 | 下载 |
---|---|
Docfx.App 将 Docfx 发布为扩展性和高级自定义的库 |
GitHub 仓库
此包未用于任何流行的 GitHub 仓库。
版本 | 下载 | 最后更新 |
---|---|---|
2.77.0 | 936 | 7/1/2024 |
2.76.0 | 3,736 | 4/7/2024 |
2.75.3 | 2,627 | 2/18/2024 |
2.75.2 | 5,000 | 1/27/2024 |
2.75.1 | 3,044 | 1/13/2024 |
2.75.0 | 1,203 | 1/12/2024 |
2.74.1 | 1,077 | 11/30/2023 |
2.74.0 | 878 | 11/20/2023 |
2.73.2 | 1,407 | 11/13/2023 |
2.73.1 | 183 | 11/7/2023 |
2.73.0 | 232 | 11/2/2023 |
2.72.1 | 186 | 10/28/2023 |
2.72.0 | 257 | 10/24/2023 |
2.71.1 | 732 | 10/18/2023 |
2.71.0 | 440 | 9/30/2023 |
2.70.4 | 302 | 9/18/2023 |
2.70.3 | 223 | 9/5/2023 |
2.70.2 | 171 | 9/4/2023 |
2.70.1 | 343 | 9/4/2023 |
2.70.0 | 1,237 | 7/29/2023 |