Microsoft.DocAsCode.MarkdigEngine.Extensions 2.67.5
前缀已保留
Docfx.MarkdigEngine.Extensions
其他详情Docfx已经完全过渡成为一个完全由社区驱动、为了社区利益而存在的.NET基金会项目。因此,我们将NuGet包名、程序集名和命名空间名从Microsoft.DocAsCode.*更改为Docfx.*。
dotnet add package Microsoft.DocAsCode.MarkdigEngine.Extensions --version 2.67.5
NuGet\Install-Package Microsoft.DocAsCode.MarkdigEngine.Extensions -Version 2.67.5
<PackageReference Include="Microsoft.DocAsCode.MarkdigEngine.Extensions" Version="2.67.5" />
paket add Microsoft.DocAsCode.MarkdigEngine.Extensions --version 2.67.5
#r "nuget: Microsoft.DocAsCode.MarkdigEngine.Extensions, 2.67.5"
// Install Microsoft.DocAsCode.MarkdigEngine.Extensions as a Cake Addin #addin nuget:?package=Microsoft.DocAsCode.MarkdigEngine.Extensions&version=2.67.5 // Install Microsoft.DocAsCode.MarkdigEngine.Extensions as a Cake Tool #tool nuget:?package=Microsoft.DocAsCode.MarkdigEngine.Extensions&version=2.67.5
使用docfx构建您的文档
使用docfx构建技术文档站点,包括着陆页面、Markdown、.NET、REST API等API参考文档。
⚠️⚠️⚠️ 注意 ⚠️⚠️⚠️
DocFX正在过渡到.NET基金会,作为官方.NET项目!
- DocFX 团队正在改进主分支。这将向项目引入新功能和错误修复,删除一些不再必要的旧代码和功能,以及更新依赖项并简化项目结构。请关注路线图。
- 由于站点架构变更,DocFX 无法再直接支持构建Microsoft Learn内容。保存着Microsoft Learn Markdown内容的开源仓库将继续接受拉取请求和更改,但无法直接用DocFX构建。
- 今后,我们只将支持此工具作为新站点的静态站点生成器,而不是作为在Microsoft Learn上构建官方Microsoft内容的工具。
入门
将docfx作为全局工具安装
dotnet tool install -g docfx
在本地创建并启动网站
docfx init -q docfx build docfx_project\docfx.json --serve
前往https://127.0.0.1:8080查看示例站点。
有关更多信息,请参阅入门。
贡献
使用讨论区提问和进行一般讨论。使用问题报告错误和提出新功能。
我们欢迎通过拉取请求贡献代码。标记为help-wanted
的问题是非常好的开始贡献代码的候选。
先决条件
- 安装Visual Studio 2022(社区版或更高版本)并确保你有最新的更新。
- 安装.NET Core SDK 6.x和7.x。
- 安装NodeJS (16.x.x)。
- 可选:在Windows上安装wkhtmltopdf来测试PDF,使用
choco install wkhtmltopdf
。
建设和测试
- 在
templates
目录中建设站点模板- 运行
npm install
以还原npm依赖项。 - 运行
npm run build
以构建模板。
- 运行
- 运行
dotnet build
来构建项目或使用Visual Studio来构建docfx.sln
。 - 运行
dotnet test
来测试项目或使用Visual Studio测试资源管理器。- 运行
git lfs checkout
以检出文件以进行快照测试
- 运行
分支和发布
main
分支是拉取请求和大多数其他开发活动的默认分支。我们偶尔使用feature/*
分支来开发大型功能。
发布基于稳定的main
分支提交,使用GitHub发布。鼓励使用常规提交。
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.31.0)
- Microsoft.DocAsCode.MarkdigEngine.Validators (>= 2.67.5)
- Newtonsoft.Json (>= 13.0.3)
-
net7.0
- Markdig (>= 0.31.0)
- Microsoft.DocAsCode.MarkdigEngine.Validators (>= 2.67.5)
- Newtonsoft.Json (>= 13.0.3)
-
net8.0
- Markdig (>= 0.31.0)
- Microsoft.DocAsCode.MarkdigEngine.Validators (>= 2.67.5)
- Newtonsoft.Json (>= 13.0.3)
NuGet 包 (3)
显示依赖于 Microsoft.DocAsCode.MarkdigEngine.Extensions 的前 3 个 NuGet 包
包 | 下载 |
---|---|
Microsoft.DocAsCode.MarkdigEngine 包描述 |
|
Dhgms.DocFx.MermaidJs.Plugin
DocFX 的 MermaidJS 插件 |
|
JeremyTCD.DocFx.Plugins
包描述 |
GitHub 代码仓库
该软件包没有被任何流行的GitHub仓库使用。
版本 | 下载 | 最后更新时间 | |
---|---|---|---|
2.67.5 | 11,032 | 6/21/2023 | |
2.67.3 | 2,129 | 6/2/2023 | |
2.67.2 | 846 | 5/26/2023 | |
2.67.1 | 868 | 5/16/2023 | |
2.67.0 | 1,159 | 5/6/2023 | |
2.66.2 | 5,029 | 4/26/2023 | |
2.66.1 | 1,616 | 4/25/2023 | |
2.66.0 | 677 | 4/24/2023 | |
2.65.3 | 905 | 4/14/2023 | |
2.65.2 | 760 | 4/11/2023 | |
2.65.1 | 562 | 4/9/2023 | |
2.65.0 | 683 | 4/7/2023 | |
2.64.0 | 1,029 | 3/30/2023 | |
2.63.1 | 1,089 | 3/21/2023 | |
2.63.0 | 694 | 3/20/2023 | |
2.62.2 | 916 | 3/7/2023 | |
2.62.1 | 2,555 | 2/15/2023 | |
2.62.0 | 621 | 2/14/2023 | |
2.61.0 | 2,676 | 1/30/2023 | |
2.60.2 | 1,185 | 1/20/2023 | |
2.60.1 | 794 | 1/18/2023 | |
2.60.0 | 1,224 | 1/13/2023 | |
2.60.0-preview.2 | 120 | 12/25/2022 | |
2.59.4 | 9,873 | 9/7/2022 | |
2.59.3 | 3,837 | 7/6/2022 | |
2.59.2 | 4,362 | 4/11/2022 | |
2.59.1 | 1,447 | 3/31/2022 | |
2.59.0 | 5,002 | 1/19/2022 | |
2.58.9 | 1,503 | 11/4/2021 | |
2.58.8 | 921 | 11/1/2021 | |
2.58.5 | 1,303 | 10/26/2021 | |
2.58.4 | 1,264 | 9/14/2021 | |
2.58.3 | 931 | 9/7/2021 | |
2.58.2 | 952 | 8/24/2021 | |
2.58.1 | 954 | 8/23/2021 | |
2.58.0 | 1,345 | 6/9/2021 | |
2.57.2 | 1,156 | 4/14/2021 | |
2.57.1 | 1,009 | 4/13/2021 | |
2.57.0 | 1,002 | 4/9/2021 | |
2.56.7 | 2,667 | 3/2/2021 | |
2.56.6 | 1,914 | 12/10/2020 | |
2.56.5 | 1,258 | 11/10/2020 | |
2.56.4 | 3,075 | 10/20/2020 | |
2.56.3 | 1,138 | 10/12/2020 | |
2.56.2 | 1,538 | 7/27/2020 | |
2.56.1 | 2,255 | 7/6/2020 | |
2.56.0 | 1,228 | 6/29/2020 | |
2.55.0 | 1,363 | 6/12/2020 | |
2.53.1 | 1,324 | 5/11/2020 | |
2.52.0 | 2,777 | 4/13/2020 | |
2.51.0 | 4,399 | 3/20/2020 | |
2.50.0 | 1,852 | 3/2/2020 | |
2.49.0 | 1,399 | 2/17/2020 | |
2.48.1 | 2,870 | 1/13/2020 | |
2.48.0 | 2,610 | 12/9/2019 | |
2.47.0 | 3,070 | 10/31/2019 | |
2.46.0 | 1,561 | 10/14/2019 | |
2.45.1 | 1,647 | 9/15/2019 | |
2.45.0 | 1,399 | 8/25/2019 | |
2.44.0 | 2,560 | 8/2/2019 | |
2.43.2 | 1,968 | 7/2/2019 | |
2.43.1 | 1,138 | 6/14/2019 | |
2.42.4 | 1,776 | 5/24/2019 | |
2.42.3 | 13,337 | 5/13/2019 | |
2.42.2 | 990 | 5/10/2019 | |
2.42.0 | 1,042 | 4/22/2019 | |
2.41.0 | 3,078 | 3/29/2019 | |
2.40.12 | 1,062 | 3/11/2019 | |
2.40.11 | 2,427 | 2/16/2019 | |
2.40.10 | 1,231 | 2/1/2019 | |
2.40.9 | 1,261 | 1/31/2019 | |
2.40.8 | 1,251 | 1/25/2019 | |
2.40.7 | 1,212 | 1/4/2019 | |
2.40.5 | 1,177 | 12/19/2018 | |
2.40.4 | 1,198 | 11/26/2018 | |
2.40.2 | 1,142 | 11/7/2018 | |
2.40.1 | 1,161 | 10/29/2018 | |
2.40.0 | 2,424 | 10/12/2018 | |
2.39.2 | 6,708 | 9/9/2018 | |
2.39.1 | 2,559 | 9/4/2018 | |
2.39.0 | 5,704 | 9/2/2018 | |
2.38.1 | 5,929 | 8/16/2018 | |
2.38.0 | 1,387 | 8/13/2018 | |
2.37.2 | 1,290 | 7/31/2018 | |
2.37.1 | 1,447 | 7/31/2018 | |
2.36.2 | 1,588 | 6/13/2018 | |
2.36.1 | 1,407 | 5/25/2018 | |
2.36.0 | 1,495 | 5/21/2018 | |
2.36.0-alpha-0159-g25e5900b4 | 1,003 | 4/26/2018 | |
2.35.4 | 1,542 | 5/2/2018 | |
2.35.3 | 1,655 | 5/2/2018 | |
2.35.0-alpha-0153-g6da267dd4 | 974 | 4/26/2018 |