Docfx.MarkdigEngine.Extensions 2.77.0
前缀已保留
dotnet add package Docfx.MarkdigEngine.Extensions --version 2.77.0
NuGet\Install-Package Docfx.MarkdigEngine.Extensions -Version 2.77.0
<PackageReference Include="Docfx.MarkdigEngine.Extensions" Version="2.77.0" />
paket add Docfx.MarkdigEngine.Extensions --version 2.77.0
#r "nuget: Docfx.MarkdigEngine.Extensions, 2.77.0"
// Install Docfx.MarkdigEngine.Extensions as a Cake Addin #addin nuget:?package=Docfx.MarkdigEngine.Extensions&version=2.77.0 // Install Docfx.MarkdigEngine.Extensions as a Cake Tool #tool nuget:?package=Docfx.MarkdigEngine.Extensions&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的最新进展。
贡献
使用讨论区来提问和进行一般讨论。使用问题来报告错误和提出功能建议。
我们欢迎通过pull请求向代码做出贡献,标记为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
分支是pull请求和大多数其他开发活动的默认分支。我们偶尔会使用feature/*
分支进行史诗级功能开发。
发布基于稳定main
分支的提交,使用GitHub Releases。鼓励使用常规提交。
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
- Markdig (>= 0.37.0)
- Newtonsoft.Json (>= 13.0.3)
- PlantUml.Net (>= 1.4.80)
-
net8.0
- Markdig (>= 0.37.0)
- Newtonsoft.Json (>= 13.0.3)
- PlantUml.Net (>= 1.4.80)
NuGet 包 (1)
显示依赖于 Docfx.MarkdigEngine.Extensions 的前 1 个 NuGet 包
包 | 下载 |
---|---|
Docfx.MarkdigEngine 具有 markdown、.NET API 文档、REST API 等技术的文档工具。 |
GitHub 仓库
此包未由任何流行 GitHub 仓库使用。
版本 | 下载 | 最后更新 |
---|---|---|
2.77.0 | 1,001 | 7/1/2024 |
2.76.0 | 4,162 | 4/7/2024 |
2.75.3 | 2,685 | 2/18/2024 |
2.75.2 | 5,063 | 1/27/2024 |
2.75.1 | 3,085 | 1/13/2024 |
2.75.0 | 1,236 | 1/12/2024 |
2.74.1 | 1,123 | 11/30/2023 |
2.74.0 | 923 | 11/20/2023 |
2.73.2 | 1,514 | 11/13/2023 |
2.73.1 | 188 | 11/7/2023 |
2.73.0 | 244 | 11/2/2023 |
2.72.1 | 206 | 10/28/2023 |
2.72.0 | 272 | 10/24/2023 |
2.71.1 | 746 | 10/18/2023 |
2.71.0 | 478 | 9/30/2023 |
2.70.4 | 322 | 9/18/2023 |
2.70.3 | 229 | 9/5/2023 |
2.70.2 | 170 | 9/4/2023 |
2.70.1 | 375 | 9/4/2023 |
2.70.0 | 1,273 | 7/29/2023 |