Microsoft.DocAsCode.MarkdigEngine 2.67.5
前缀已保留
由于Docfx已完全转变为.NET Foundation项目,完全由社区推动,旨在造福社区,因此我们正在将NuGet包名、程序集名和命名空间名从Microsoft.DocAsCode.*重命名为Docfx.*。
dotnet add package Microsoft.DocAsCode.MarkdigEngine --version 2.67.5
NuGet\Install-Package Microsoft.DocAsCode.MarkdigEngine -Version 2.67.5
<PackageReference Include="Microsoft.DocAsCode.MarkdigEngine" Version="2.67.5" />
paket add Microsoft.DocAsCode.MarkdigEngine --version 2.67.5
#r "nuget: Microsoft.DocAsCode.MarkdigEngine, 2.67.5"
// Install Microsoft.DocAsCode.MarkdigEngine as a Cake Addin #addin nuget:?package=Microsoft.DocAsCode.MarkdigEngine&version=2.67.5 // Install Microsoft.DocAsCode.MarkdigEngine as a Cake Tool #tool nuget:?package=Microsoft.DocAsCode.MarkdigEngine&version=2.67.5
使用docfx构建您的文档
使用docfx构建您的技术文档网站,包括着陆页、Markdown、.NET、REST API等的API引用文档。
⚠️⚠️⚠️ 注意 ⚠️⚠️⚠️
DocFX正在过渡至.NET Foundation作为一个官方.NET项目!
- DocFX 团队正在改进主分支。这将向项目引入新功能和错误修复,删除一些不再必要的旧代码和功能,以及更新依赖项并简化项目结构。请关注路线图。
- 由于 网站架构变更,DocFX 无法再直接支持构建 Microsoft Learn 内容。仍然接受含有 Markdown 内容的 Microsoft Learn 代码仓库的 pull request 和更改,但不能直接用 DocFX 构建。
- 未来,我们将只支持该工具作为新站点的静态网站生成器,而不是构建官方 Microsoft Learn 内容的工具。
入门
将 docfx 安装为全局工具
dotnet tool install -g docfx
创建并本地启动网站
docfx init -q docfx build docfx_project\docfx.json --serve
前往 https://127.0.0.1:8080 查看示例网站。
有关更多信息,请参阅 入门。
贡献
使用 讨论 提出问题和一般讨论。使用 问题 报告错误和提出功能建议。
我们欢迎通过 pull requests 进行代码贡献。标记为 help-wanted
的问题都是开始贡献代码的好选择。
先决条件
- 安装 Visual Studio 2022 (社区版或更高版本) 并确保您已安装最新更新。
- 安装 .NET Core SDK 6.x 和 7.x。
- 安装 NodeJS (16.x.x)。
- 可选:在 Windows 上使用
choco install wkhtmltopdf
安装 wkhtmltopdf 以测试 PDF。
构建和测试
- 在
templates
目录中构建网站模板- 运行
npm install
以还原 npm 依赖项。 - 运行
npm run build
以构建模板。
- 运行
- 运行
dotnet build
以构建项目或使用 Visual Studio 构建docfx.sln
。 - 运行
dotnet test
以测试项目或使用 Visual Studio 测试资源管理器。- 运行
git lfs checkout
以获取快照测试的文件
- 运行
分支和发行版
main
分支是 pull request 和大多数其他开发活动的默认分支。我们会偶尔使用 feature/*
分支进行大型功能开发。
发行版基于稳定的 main
分支提交使用 GitHub Releases。鼓励使用 常规提交。
Docfx 不是 以常规节奏发布的,新版本在维护者看到足够多的更改以支持新版本时发布。有时我们会使用预发布版来测试破坏性更改并从社区获取反馈。
路线图
我们使用 里程碑 来沟通即将到来的 Docfx 改变
许可证
该项目根据 MIT 许可证授权。
.NET Foundation
该项目得到 .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
- Markdig (>= 0.31.0)
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.MarkdigEngine.Extensions (>= 2.67.5)
- Microsoft.DocAsCode.YamlSerialization (>= 2.67.5)
- Newtonsoft.Json (>= 13.0.3)
- System.Collections.Immutable (>= 7.0.0)
- System.Composition (>= 7.0.0)
-
net7.0
- Markdig (>= 0.31.0)
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.MarkdigEngine.Extensions (>= 2.67.5)
- Microsoft.DocAsCode.YamlSerialization (>= 2.67.5)
- Newtonsoft.Json (>= 13.0.3)
- System.Collections.Immutable (>= 7.0.0)
- System.Composition (>= 7.0.0)
-
net8.0
- Markdig (>= 0.31.0)
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.MarkdigEngine.Extensions (>= 2.67.5)
- Microsoft.DocAsCode.YamlSerialization (>= 2.67.5)
- Newtonsoft.Json (>= 13.0.3)
- System.Collections.Immutable (>= 7.0.0)
- System.Composition (>= 7.0.0)
NuGet 包 (4)
显示依赖 Microsoft.DocAsCode.MarkdigEngine 的前 4 个 NuGet 包
包 | 下载 |
---|---|
Microsoft.DocAsCode.Build.SchemaDriven 包描述 |
|
Microsoft.DocAsCode.App Docfx作为库发布,支持扩展和高级定制 |
|
DocFX.Plugins.Roadmap
一个DocFX插件,允许您可视化 https://roadmap.sierrasoftworks.com。 |
|
JeremyTCD.DocFx.Plugins
包描述 |
GitHub仓库
此包未被任何流行的GitHub仓库使用。
版本 | 下载 | 最后更新 | |
---|---|---|---|
2.67.5 | 9,746 | 6/21/2023 | |
2.67.3 | 1,839 | 6/2/2023 | |
2.67.2 | 605 | 5/26/2023 | |
2.67.1 | 635 | 5/16/2023 | |
2.67.0 | 1,027 | 5/6/2023 | |
2.66.2 | 4,860 | 4/26/2023 | |
2.66.1 | 1,481 | 4/25/2023 | |
2.66.0 | 557 | 4/24/2023 | |
2.65.3 | 639 | 4/14/2023 | |
2.65.2 | 599 | 4/11/2023 | |
2.65.1 | 487 | 4/9/2023 | |
2.65.0 | 528 | 4/7/2023 | |
2.64.0 | 710 | 3/30/2023 | |
2.63.1 | 873 | 3/21/2023 | |
2.63.0 | 591 | 3/20/2023 | |
2.62.2 | 765 | 3/7/2023 | |
2.62.1 | 2,300 | 2/15/2023 | |
2.62.0 | 540 | 2/14/2023 | |
2.61.0 | 2,575 | 1/30/2023 | |
2.60.2 | 1,058 | 1/20/2023 | |
2.60.1 | 622 | 1/18/2023 | |
2.60.0 | 1,091 | 1/13/2023 | |
2.60.0-preview.2 | 123 | 12/25/2022 | |
2.59.4 | 9,810 | 9/7/2022 | |
2.59.3 | 3,507 | 7/6/2022 | |
2.59.2 | 3,927 | 4/11/2022 | |
2.59.1 | 1,100 | 3/31/2022 | |
2.59.0 | 4,587 | 1/19/2022 | |
2.58.9 | 1,207 | 11/4/2021 | |
2.58.8 | 695 | 11/1/2021 | |
2.58.5 | 1,069 | 10/26/2021 | |
2.58.4 | 1,036 | 9/14/2021 | |
2.58.3 | 703 | 9/7/2021 | |
2.58.2 | 763 | 8/24/2021 | |
2.58.1 | 748 | 8/23/2021 | |
2.58.0 | 1,102 | 6/9/2021 | |
2.57.2 | 896 | 4/14/2021 | |
2.57.1 | 755 | 4/13/2021 | |
2.57.0 | 751 | 4/9/2021 | |
2.56.7 | 2,429 | 3/2/2021 | |
2.56.6 | 1,633 | 12/10/2020 | |
2.56.5 | 903 | 11/10/2020 | |
2.56.4 | 2,804 | 10/20/2020 | |
2.56.3 | 855 | 10/12/2020 | |
2.56.2 | 1,125 | 7/27/2020 | |
2.56.1 | 1,004 | 7/6/2020 | |
2.56.0 | 984 | 6/29/2020 | |
2.55.0 | 1,039 | 6/12/2020 | |
2.53.1 | 1,048 | 5/11/2020 | |
2.52.0 | 1,205 | 4/13/2020 | |
2.51.0 | 2,960 | 3/20/2020 | |
2.50.0 | 1,171 | 3/2/2020 | |
2.49.0 | 1,043 | 2/17/2020 | |
2.48.1 | 2,660 | 1/13/2020 | |
2.48.0 | 1,669 | 12/9/2019 | |
2.47.0 | 1,350 | 10/31/2019 | |
2.46.0 | 1,392 | 10/14/2019 | |
2.45.1 | 3,132 | 9/15/2019 | |
2.45.0 | 1,208 | 8/25/2019 | |
2.44.0 | 1,911 | 8/2/2019 | |
2.43.2 | 1,853 | 7/2/2019 | |
2.43.1 | 922 | 6/14/2019 | |
2.42.4 | 1,696 | 5/24/2019 | |
2.42.3 | 13,106 | 5/13/2019 | |
2.42.2 | 801 | 5/10/2019 | |
2.42.0 | 836 | 4/22/2019 | |
2.41.0 | 2,882 | 3/29/2019 | |
2.40.12 | 812 | 3/11/2019 | |
2.40.11 | 2,231 | 2/16/2019 | |
2.40.10 | 987 | 2/1/2019 | |
2.40.9 | 1,015 | 1/31/2019 | |
2.40.8 | 959 | 1/25/2019 | |
2.40.7 | 932 | 1/4/2019 | |
2.40.5 | 987 | 12/19/2018 | |
2.40.4 | 897 | 11/26/2018 | |
2.40.2 | 925 | 11/7/2018 | |
2.40.1 | 888 | 10/29/2018 | |
2.40.0 | 986 | 10/12/2018 | |
2.39.2 | 6,488 | 9/9/2018 | |
2.39.1 | 2,350 | 9/4/2018 | |
2.39.0 | 5,473 | 9/2/2018 | |
2.38.1 | 5,609 | 8/16/2018 | |
2.38.0 | 1,183 | 8/13/2018 | |
2.37.2 | 1,084 | 7/31/2018 | |
2.37.1 | 1,291 | 7/31/2018 | |
2.36.2 | 1,309 | 6/13/2018 | |
2.36.1 | 1,108 | 5/25/2018 | |
2.36.0 | 1,182 | 5/21/2018 | |
2.36.0-alpha-0159-g25e5900b4 | 916 | 4/26/2018 | |
2.35.4 | 1,329 | 5/2/2018 | |
2.35.3 | 1,386 | 5/2/2018 | |
2.35.0-alpha-0153-g6da267dd4 | 920 | 4/26/2018 |