Microsoft.DocAsCode. 2.63.1
前缀已保留
dotnet add package Microsoft.DocAsCode.Dfm --version 2.63.1
NuGet\Install-Package Microsoft.DocAsCode.Dfm -Version 2.63.1
<PackageReference Include="Microsoft.DocAsCode.Dfm" Version="2.63.1" />
paket add Microsoft.DocAsCode.Dfm --version 2.63.1
#r "nuget: Microsoft.DocAsCode.Dfm, 2.63.1"
// Install Microsoft.DocAsCode.Dfm as a Cake Addin #addin nuget:?package=Microsoft.DocAsCode.Dfm&version=2.63.1 // Install Microsoft.DocAsCode.Dfm as a Cake Tool #tool nuget:?package=Microsoft.DocAsCode.Dfm&version=2.63.1
使用 docfx 打造您的文档
使用 docfx 打造您的技术文档网站,包括着陆页、Markdown、.NET、REST API 等文档。
⚠️⚠️⚠️ 注意事项 ⚠️⚠️⚠️
- 对于 Microsoft Learn 用户,docfx 的开源版本 不会 维护以支持 Microsoft Learn 内容。有关 Microsoft Learn 的功能请求、错误报告和其他支持问题,请使用内部渠道,例如 Learn 平台支持渠道。
- V3 分支已私有化以支持 Microsoft Learn,公共场合开发 V3 分支已 正式停止。
入门
将 docfx 安装为全局工具
dotnet tool install -g docfx
在本地创建和启动网站
docfx init -q docfx docfx_project\docfx.json --serve
访问 https://localhost:8080 查看示例网站。
获取更多信息,请参阅 入门指南。
贡献
对于问题和一般讨论,请使用 讨论区。使用 问题跟踪 报告错误或提出功能建议。
我们欢迎通过 pull requests 贡献代码。标签为 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
分支是默认的 pull request 分支和大多数其他开发活动的分支。我们偶尔使用 feature/*
分支进行史诗功能开发。
发布基于稳定的 main
分支提交,使用 GitHub Releases。鼓励使用 conventional commits 格式。
docfx 不遵循常规发布节奏,新版本到达时维护者认为有足够的更改值得发布新版本。有时我们使用预发布版来试验破坏性更改并从社区获取反馈。
路线图
我们使用 里程碑 传达即将到来的 docfx 变更。
.NET 基金会
此项目由 .NET 基金会 支持。
此项目采用了 贡献者契约 中定义的行为准则,以阐明我们在社区中期望的行为。有关更多信息,请参阅 .NET 基金会行为准则。
许可
此项目许可协议为 MIT 协议。
产品 | 版本 兼容的和额外的计算目标框架版本。 |
---|---|
.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
- HtmlAgilityPack (>= 1.11.46)
- Microsoft.DocAsCode.Common (>= 2.63.1)
- Microsoft.DocAsCode.MarkdownLite (>= 2.63.1)
- Microsoft.DocAsCode.Plugins (>= 2.63.1)
- Microsoft.DocAsCode.YamlSerialization (>= 2.63.1)
-
net7.0
- HtmlAgilityPack (>= 1.11.46)
- Microsoft.DocAsCode.Common (>= 2.63.1)
- Microsoft.DocAsCode.MarkdownLite (>= 2.63.1)
- Microsoft.DocAsCode.Plugins (>= 2.63.1)
- Microsoft.DocAsCode.YamlSerialization (>= 2.63.1)
-
net8.0
- HtmlAgilityPack (>= 1.11.46)
- Microsoft.DocAsCode.Common (>= 2.63.1)
- Microsoft.DocAsCode.MarkdownLite (>= 2.63.1)
- Microsoft.DocAsCode.Plugins (>= 2.63.1)
- Microsoft.DocAsCode.YamlSerialization (>= 2.63.1)
NuGet 包 (5)
显示依赖于 Microsoft.DocAsCode.Dfm 的前 5 个 NuGet 包
包 | 下载 |
---|---|
Microsoft.DocAsCode.AzureMarkdownRewriters Microsoft.DocAsCode.AzureMarkdownRewriters |
|
Microsoft.DocAsCode.Build.MergeOverwrite 包描述 |
|
Microsoft.DocAsCode.MarkdigMarkdownRewriters 包描述 |
|
JeremyTCD.DocFx.Plugins.MimoMarkdown
一个DocFx markdown渲染插件。MimoMarkdown渲染适用于Mimo文档/博客主题的markdown。 |
|
JeremyTCD.DocFx.Plugins
包描述 |
GitHub仓库 (1)
显示依赖Microsoft.DocAsCode.Dfm的GitHub最热门的前1个仓库
仓库 | 星标数 |
---|---|
apache/lucenenet
Apache Lucene.NET
|
版本 | 下载 | 最后更新 | |
---|---|---|---|
2.63.1 | 4,266 | 3/21/2023 | |
2.63.0 | 771 | 3/20/2023 | |
2.62.2 | 961 | 3/7/2023 | |
2.62.1 | 2,324 | 2/15/2023 | |
2.62.0 | 795 | 2/14/2023 | |
2.61.0 | 2,902 | 1/30/2023 | |
2.60.2 | 1,414 | 1/20/2023 | |
2.60.1 | 956 | 1/18/2023 | |
2.60.0 | 1,466 | 1/13/2023 | |
2.60.0-preview.2 | 140 | 12/25/2022 | |
2.60.0-preview.1 | 127 | 12/20/2022 | |
2.59.4 | 12,643 | 9/7/2022 | |
2.59.3 | 2,207 | 7/6/2022 | |
2.59.2 | 5,246 | 4/11/2022 | |
2.59.1 | 1,495 | 3/31/2022 | |
2.59.0 | 3,585 | 1/19/2022 | |
2.58.9 | 906 | 11/4/2021 | |
2.58.8 | 551 | 11/1/2021 | |
2.58.5 | 543 | 10/26/2021 | |
2.58.4 | 3,894 | 9/14/2021 | |
2.58.3 | 556 | 9/7/2021 | |
2.58.2 | 568 | 8/24/2021 | |
2.58.1 | 546 | 8/23/2021 | |
2.58.0 | 1,527 | 6/9/2021 | |
2.57.2 | 804 | 4/14/2021 | |
2.57.1 | 614 | 4/13/2021 | |
2.57.0 | 634 | 4/9/2021 | |
2.56.7 | 1,771 | 3/2/2021 | |
2.56.6 | 1,532 | 12/10/2020 | |
2.56.5 | 903 | 11/10/2020 | |
2.56.4 | 2,692 | 10/20/2020 | |
2.56.3 | 719 | 10/12/2020 | |
2.56.2 | 1,184 | 7/27/2020 | |
2.56.1 | 876 | 7/6/2020 | |
2.56.0 | 791 | 6/29/2020 | |
2.55.0 | 924 | 6/12/2020 | |
2.53.1 | 1,052 | 5/11/2020 | |
2.52.0 | 1,455 | 4/13/2020 | |
2.51.0 | 3,053 | 3/20/2020 | |
2.50.0 | 1,064 | 3/2/2020 | |
2.49.0 | 845 | 2/17/2020 | |
2.48.1 | 3,258 | 1/13/2020 | |
2.48.0 | 1,806 | 12/9/2019 | |
2.47.0 | 23,572 | 10/31/2019 | |
2.46.0 | 1,344 | 10/14/2019 | |
2.45.1 | 3,036 | 9/15/2019 | |
2.45.0 | 1,152 | 8/25/2019 | |
2.44.0 | 1,867 | 8/2/2019 | |
2.43.2 | 2,036 | 7/2/2019 | |
2.43.1 | 1,176 | 6/14/2019 | |
2.42.4 | 1,957 | 5/24/2019 | |
2.42.3 | 13,347 | 5/21/2019 | |
2.42.2 | 946 | 5/10/2019 | |
2.42.0 | 996 | 4/22/2019 | |
2.41.0 | 3,111 | 3/29/2019 | |
2.40.12 | 1,036 | 3/11/2019 | |
2.40.11 | 2,366 | 2/16/2019 | |
2.40.10 | 1,240 | 2/1/2019 | |
2.40.9 | 1,203 | 1/31/2019 | |
2.40.8 | 1,189 | 1/25/2019 | |
2.40.7 | 1,149 | 1/4/2019 | |
2.40.5 | 1,210 | 12/19/2018 | |
2.40.4 | 1,199 | 11/26/2018 | |
2.40.2 | 1,618 | 11/7/2018 | |
2.40.1 | 1,105 | 10/29/2018 | |
2.40.0 | 1,163 | 10/12/2018 | |
2.39.2 | 2,649 | 9/9/2018 | |
2.39.1 | 2,584 | 9/4/2018 | |
2.39.0 | 5,766 | 9/2/2018 | |
2.38.1 | 5,932 | 8/16/2018 | |
2.38.0 | 1,365 | 8/13/2018 | |
2.37.2 | 1,288 | 7/31/2018 | |
2.37.1 | 1,495 | 7/31/2018 | |
2.36.2 | 1,557 | 6/13/2018 | |
2.36.1 | 1,373 | 5/25/2018 | |
2.36.0 | 1,420 | 5/21/2018 | |
2.36.0-alpha-0159-g25e5900b4 | 965 | 4/26/2018 | |
2.35.4 | 1,493 | 5/2/2018 | |
2.35.3 | 1,428 | 5/2/2018 | |
2.35.0-alpha-0153-g6da267dd4 | 865 | 4/25/2018 | |
2.33.2 | 27,125 | 4/3/2018 | |
2.33.1 | 1,261 | 4/3/2018 | |
2.33.0 | 1,402 | 3/19/2018 | |
2.32.2 | 1,467 | 3/12/2018 | |
2.32.0 | 1,437 | 2/28/2018 | |
2.31.0 | 1,497 | 2/5/2018 | |
2.30.0 | 1,425 | 1/12/2018 | |
2.29.1 | 1,548 | 12/29/2017 | |
2.28.3 | 1,295 | 12/14/2017 | |
2.28.2 | 1,282 | 12/7/2017 | |
2.28.1 | 1,400 | 12/1/2017 | |
2.28.0 | 1,365 | 11/30/2017 | |
2.27.0 | 1,350 | 11/21/2017 | |
2.26.3 | 1,453 | 10/26/2017 | |
2.26.1 | 1,289 | 10/24/2017 | |
2.26.0 | 1,217 | 10/23/2017 | |
2.25.1 | 1,295 | 10/9/2017 | |
2.25.0 | 1,493 | 10/9/2017 | |
2.24.0 | 6,142 | 9/11/2017 | |
2.23.1 | 1,264 | 8/22/2017 | |
2.22.3 | 1,342 | 8/17/2017 | |
2.22.1 | 1,458 | 8/2/2017 | |
2.22.0 | 1,308 | 8/1/2017 | |
2.21.2 | 1,278 | 7/26/2017 | |
2.21.1 | 1,360 | 7/17/2017 | |
2.20.0 | 1,326 | 7/12/2017 | |
2.19.2 | 1,419 | 6/29/2017 | |
2.18.5 | 1,376 | 6/15/2017 | |
2.18.4 | 1,371 | 6/9/2017 | |
2.18.3 | 1,389 | 6/8/2017 | |
2.18.1 | 1,256 | 5/31/2017 | |
2.17.5 | 1,222 | 5/23/2017 | |
2.17.3 | 1,432 | 5/11/2017 | |
2.17.2 | 1,230 | 5/9/2017 | |
2.16.8 | 1,180 | 5/3/2017 | |
2.16.7 | 1,242 | 4/26/2017 | |
2.16.5 | 1,190 | 4/25/2017 | |
2.16.2 | 1,181 | 4/20/2017 | |
2.16.0 | 1,211 | 4/17/2017 | |
2.15.5 | 1,839 | 4/6/2017 | |
2.15.2 | 1,897 | 3/29/2017 | |
2.13.1 | 1,793 | 3/7/2017 | |
2.13.0 | 1,808 | 3/6/2017 | |
2.12.1 | 1,937 | 2/14/2017 | |
2.12.0 | 1,841 | 2/13/2017 | |
2.11.3 | 1,697 | 2/7/2017 | |
2.11.2 | 1,683 | 1/25/2017 | |
2.11.1 | 1,748 | 1/24/2017 | |
2.11.0 | 1,763 | 1/23/2017 | |
2.10.2 | 1,765 | 1/4/2017 | |
2.10.1 | 1,862 | 1/4/2017 | |
2.10.0 | 2,023 | 1/3/2017 | |
2.9.3 | 1,687 | 12/15/2016 | |
2.9.2 | 1,721 | 12/14/2016 | |
2.9.1 | 1,632 | 12/13/2016 | |
2.9.0 | 1,655 | 12/12/2016 | |
2.8.2 | 1,764 | 11/28/2016 | |
2.8.1 | 1,791 | 11/24/2016 | |
2.8.0 | 1,966 | 11/22/2016 | |
2.7.3 | 2,067 | 11/8/2016 | |
2.7.2 | 1,924 | 11/3/2016 | |
2.7.1 | 1,995 | 11/1/2016 | |
2.7.0 | 1,811 | 10/31/2016 | |
2.6.3 | 1,767 | 10/25/2016 | |
2.6.1 | 1,714 | 10/11/2016 | |
2.6.0 | 1,765 | 10/10/2016 | |
2.5.4 | 2,200 | 9/22/2016 | |
2.5.3 | 2,061 | 9/20/2016 | |
2.5.2 | 1,885 | 9/19/2016 | |
2.5.1 | 1,899 | 9/19/2016 | |
2.5.0 | 1,779 | 9/14/2016 | |
2.4.0 | 1,533 | 8/29/2016 | |
2.3.1 | 1,284 | 8/22/2016 | |
2.3.0 | 1,455 | 8/8/2016 | |
2.2.2 | 1,387 | 7/22/2016 | |
2.2.1 | 1,361 | 7/19/2016 | |
2.2.0 | 1,353 | 7/18/2016 | |
2.1.0 | 1,479 | 6/27/2016 | |
2.0.2 | 1,325 | 6/22/2016 | |
2.0.1 | 1,400 | 6/7/2016 | |
2.0.0 | 1,318 | 6/6/2016 | |
1.9.4 | 1,549 | 5/19/2016 | |
1.9.3 | 1,317 | 5/19/2016 | |
1.9.0 | 1,326 | 5/16/2016 | |
1.8.4 | 1,316 | 5/10/2016 | |
1.8.1 | 1,371 | 5/4/2016 | |
1.8.0 | 1,585 | 4/25/2016 | |
1.7.2 | 1,323 | 4/20/2016 | |
1.7.1 | 1,353 | 4/7/2016 | |
1.7.0 | 1,402 | 4/6/2016 | |
1.6.1 | 1,317 | 3/16/2016 | |
1.5.0 | 1,503 | 2/22/2016 | |
1.4.2 | 1,369 | 2/3/2016 | |
1.4.1 | 1,271 | 2/2/2016 | |
1.4.0 | 1,251 | 2/1/2016 | |
1.3.7 | 1,331 | 1/21/2016 | |
1.3.5 | 1,350 | 1/13/2016 | |
1.3.3 | 1,445 | 1/13/2016 | |
1.3.0 | 1,464 | 1/11/2016 |