Microsoft.DocAsCode.Build.TableOfContents 2.67.5
预留前缀
Docfx已经完全转型为一个由社区完全推动的.NET基金会项目,以出于社区利益的考虑。因此,我们将NuGet包名、程序集名和命名空间名从Microsoft.DocAsCode.*更改为Docfx.*。
dotnet add package Microsoft.DocAsCode.Build.TableOfContents --version 2.67.5
NuGet\Install-Package Microsoft.DocAsCode.Build.TableOfContents -Version 2.67.5
<PackageReference Include="Microsoft.DocAsCode.Build.TableOfContents" Version="2.67.5" />
paket add Microsoft.DocAsCode.Build.TableOfContents --version 2.67.5
#r "nuget: Microsoft.DocAsCode.Build.TableOfContents, 2.67.5"
// Install Microsoft.DocAsCode.Build.TableOfContents as a Cake Addin #addin nuget:?package=Microsoft.DocAsCode.Build.TableOfContents&version=2.67.5 // Install Microsoft.DocAsCode.Build.TableOfContents as a Cake Tool #tool nuget:?package=Microsoft.DocAsCode.Build.TableOfContents&version=2.67.5
使用docfx构建您的文档
使用docfx构建技术文档站点,包括首页、Markdown、.NET、REST API的API参考文档等。
⚠️⚠️⚠️ 注意 ⚠️⚠️⚠️
DocFX正在转型为.NET基金会的一个官方.NET项目!
- DocFX团队正在努力改善主要分支。这将为项目引入新功能和错误修复,移除一些不再必要的旧代码和功能,以及更新依赖并简化项目结构。请持续关注路线图。
- 由于站点架构的变更[1],DocFX 无法再直接支持构建 Microsoft Learn 内容。但仍可接收针对用于 Microsoft Learn 的 Markdown 内容的开源仓库的pull请求和更改,但这些内容不能直接使用 DocFX 构建。
- 未来,我们只会将此工具作为新的网站生成器进行支持,而不是作为在 Microsoft Learn 上构建官方 Microsoft 内容的工具。
入门
将 docfx 安装为全局工具
dotnet tool install -g docfx
在本地上创建并启动一个网站
docfx init -q docfx build docfx_project\docfx.json --serve
前往 https://localhost:8080 查看示例网站。
获取更多信息,请参阅 入门指南。
贡献
对疑问和一般讨论,请使用 讨论区;报告错误和提出功能建议,请使用 问题报告。
我们通过 pull request 欢迎代码贡献,带有 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 requests 和大多数其他开发活动的默认分支。我们偶尔使用 feature/*
分支进行重要功能开发。
发布基于稳定的主分支提交,使用 GitHub Releases。推荐使用 约定式提交。
Docfx 不是按照常规计划发布的,新的版本在维护者认为有足够的变更以支持新版本时发布。有时我们使用预发布版本进行破坏性变更的狗粮测试,并从社区获取反馈。
路线图
我们使用 里程碑 来传达即将到来的 docfx 变更。
正在开发的功能集合(Working Set)是正在积极开发中的特性。并非这个桶中的所有功能都将在下一个版本中提交,但它们反映了维护者在即将到来的期间最关心的问题。
待办事项列表 是一些未来版本的潜在特性集合,但它们尚未积极开发。
许可证
此项目根据 MIT 许可证授权。
.NET基金会
此项目由 .NET 基金会 支持的。
此项目采用了由 贡献者公约(Contributor Covenant)定义的行为准则,以阐明我们社区内期望的行为。有关更多信息,请参阅 .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
- Microsoft.DocAsCode.Build.Common (>= 2.67.5)
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.5)
- Microsoft.DocAsCode.Plugins (>= 2.67.5)
- Microsoft.DocAsCode.YamlSerialization (>= 2.67.5)
-
net7.0
- Microsoft.DocAsCode.Build.Common (>= 2.67.5)
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.5)
- Microsoft.DocAsCode.Plugins (>= 2.67.5)
- Microsoft.DocAsCode.YamlSerialization (>= 2.67.5)
-
net8.0
- Microsoft.DocAsCode.Build.Common (>= 2.67.5)
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.5)
- Microsoft.DocAsCode.Plugins (>= 2.67.5)
- Microsoft.DocAsCode.YamlSerialization (>= 2.67.5)
NuGet 包 (1)
显示对 Microsoft.DocAsCode.Build.TableOfContents 依赖的前 1 个 NuGet 包
包 | 下载 |
---|---|
Microsoft.DocAsCode.App Docfx 以库的形式发布,以便进行扩展和高级自定义 |
GitHub 仓库 (1)
显示对 Microsoft.DocAsCode.Build.TableOfContents 依赖的前 1 个流行 GitHub 仓库
仓库 | 星标 |
---|---|
hazelcast/hazelcast-csharp-client
Hazelcast .NET 客户端
|
版本 | 下载 | 最新更新 | |
---|---|---|---|
2.67.5 | 9,264 | 6/21/2023 | |
2.67.3 | 2,004 | 6/2/2023 | |
2.67.2 | 850 | 5/26/2023 | |
2.67.1 | 957 | 5/16/2023 | |
2.67.0 | 1,332 | 5/6/2023 | |
2.66.2 | 5,179 | 4/26/2023 | |
2.66.1 | 821 | 4/25/2023 | |
2.66.0 | 830 | 4/24/2023 | |
2.65.3 | 922 | 4/14/2023 | |
2.65.2 | 848 | 4/11/2023 | |
2.65.1 | 797 | 4/9/2023 | |
2.65.0 | 824 | 4/7/2023 | |
2.64.0 | 5,376 | 3/30/2023 | |
2.63.1 | 1,110 | 3/21/2023 | |
2.63.0 | 800 | 3/20/2023 | |
2.62.2 | 946 | 3/7/2023 | |
2.62.1 | 2,372 | 2/15/2023 | |
2.62.0 | 856 | 2/14/2023 | |
2.61.0 | 2,807 | 1/30/2023 | |
2.60.2 | 1,328 | 1/20/2023 | |
2.60.1 | 886 | 1/18/2023 | |
2.60.0 | 1,328 | 1/13/2023 | |
2.60.0-preview.2 | 132 | 12/25/2022 | |
2.60.0-preview.1 | 126 | 12/20/2022 | |
2.59.4 | 12,208 | 9/7/2022 | |
2.59.3 | 1,765 | 7/6/2022 | |
2.59.2 | 4,919 | 4/11/2022 | |
2.59.1 | 1,192 | 3/31/2022 | |
2.59.0 | 3,535 | 1/19/2022 | |
2.58.9 | 1,254 | 11/4/2021 | |
2.58.8 | 1,013 | 11/1/2021 | |
2.58.5 | 990 | 10/26/2021 | |
2.58.4 | 4,341 | 9/14/2021 | |
2.58.3 | 1,047 | 9/7/2021 | |
2.58.2 | 999 | 8/24/2021 | |
2.58.1 | 988 | 8/23/2021 | |
2.58.0 | 1,342 | 6/9/2021 | |
2.57.2 | 1,123 | 4/14/2021 | |
2.57.1 | 1,009 | 4/13/2021 | |
2.57.0 | 1,016 | 4/9/2021 | |
2.56.7 | 2,220 | 3/2/2021 | |
2.56.6 | 1,853 | 12/10/2020 | |
2.56.5 | 1,186 | 11/10/2020 | |
2.56.4 | 1,465 | 10/20/2020 | |
2.56.3 | 1,135 | 10/12/2020 | |
2.56.2 | 1,334 | 7/27/2020 | |
2.56.1 | 1,128 | 7/6/2020 | |
2.56.0 | 1,225 | 6/29/2020 | |
2.55.0 | 1,220 | 6/12/2020 | |
2.53.1 | 1,274 | 5/11/2020 | |
2.52.0 | 1,501 | 4/13/2020 | |
2.51.0 | 3,569 | 3/20/2020 | |
2.50.0 | 1,478 | 3/2/2020 | |
2.49.0 | 1,281 | 2/17/2020 | |
2.48.1 | 2,673 | 1/13/2020 | |
2.48.0 | 1,573 | 12/9/2019 | |
2.47.0 | 1,540 | 10/31/2019 | |
2.46.0 | 1,506 | 10/14/2019 | |
2.45.1 | 3,274 | 9/15/2019 | |
2.45.0 | 1,493 | 8/25/2019 | |
2.44.0 | 1,554 | 8/2/2019 | |
2.43.2 | 2,357 | 7/2/2019 | |
2.43.1 | 1,367 | 6/14/2019 | |
2.42.4 | 2,133 | 5/24/2019 | |
2.42.3 | 13,638 | 5/13/2019 | |
2.42.2 | 1,270 | 5/10/2019 | |
2.42.0 | 1,395 | 4/22/2019 | |
2.41.0 | 1,714 | 3/29/2019 | |
2.40.12 | 1,318 | 3/11/2019 | |
2.40.11 | 1,798 | 2/16/2019 | |
2.40.10 | 1,417 | 2/1/2019 | |
2.40.9 | 1,431 | 1/31/2019 | |
2.40.8 | 1,393 | 1/25/2019 | |
2.40.7 | 1,451 | 1/4/2019 | |
2.40.5 | 1,439 | 12/19/2018 | |
2.40.4 | 1,487 | 11/26/2018 | |
2.40.2 | 1,791 | 11/7/2018 | |
2.40.1 | 1,467 | 10/29/2018 | |
2.40.0 | 1,525 | 10/12/2018 | |
2.39.2 | 2,989 | 9/9/2018 | |
2.39.1 | 2,912 | 9/4/2018 | |
2.39.0 | 6,820 | 9/2/2018 | |
2.38.1 | 6,141 | 8/16/2018 | |
2.38.0 | 1,714 | 8/13/2018 | |
2.37.2 | 1,583 | 7/31/2018 | |
2.37.1 | 1,554 | 7/31/2018 | |
2.36.2 | 1,650 | 6/13/2018 | |
2.36.1 | 1,724 | 5/25/2018 | |
2.36.0 | 1,728 | 5/21/2018 | |
2.36.0-alpha-0159-g25e5900b4 | 1,333 | 4/26/2018 | |
2.35.4 | 1,793 | 5/2/2018 | |
2.35.3 | 1,763 | 5/2/2018 | |
2.35.0-alpha-0153-g6da267dd4 | 1,407 | 4/25/2018 | |
2.33.2 | 2,014 | 4/3/2018 | |
2.33.1 | 1,630 | 4/3/2018 | |
2.33.0 | 1,772 | 3/19/2018 | |
2.32.2 | 1,809 | 3/12/2018 | |
2.32.0 | 1,760 | 2/28/2018 | |
2.31.0 | 1,657 | 2/5/2018 | |
2.30.0 | 1,784 | 1/12/2018 | |
2.29.1 | 1,723 | 12/29/2017 | |
2.28.3 | 1,615 | 12/14/2017 | |
2.28.2 | 1,610 | 12/7/2017 | |
2.28.1 | 1,613 | 12/1/2017 | |
2.28.0 | 1,645 | 11/30/2017 | |
2.27.0 | 1,634 | 11/21/2017 | |
2.26.3 | 1,718 | 10/26/2017 | |
2.26.1 | 1,650 | 10/24/2017 | |
2.26.0 | 1,642 | 10/23/2017 | |
2.25.1 | 1,624 | 10/9/2017 | |
2.25.0 | 1,632 | 10/9/2017 | |
2.24.0 | 1,751 | 9/11/2017 | |
2.23.1 | 1,659 | 8/22/2017 | |
2.22.3 | 1,657 | 8/17/2017 | |
2.22.1 | 1,731 | 8/2/2017 | |
2.22.0 | 1,708 | 8/1/2017 | |
2.21.2 | 1,711 | 7/26/2017 | |
2.21.1 | 1,691 | 7/17/2017 | |
2.20.0 | 1,701 | 7/12/2017 | |
2.19.2 | 1,685 | 6/29/2017 | |
2.18.5 | 1,710 | 6/15/2017 | |
2.18.4 | 1,717 | 6/9/2017 | |
2.18.3 | 1,751 | 6/8/2017 | |
2.18.1 | 1,669 | 5/31/2017 | |
2.17.5 | 1,716 | 5/23/2017 | |
2.17.3 | 1,662 | 5/11/2017 | |
2.17.2 | 1,693 | 5/9/2017 | |
2.16.8 | 1,671 | 5/3/2017 | |
2.16.7 | 1,673 | 4/26/2017 | |
2.16.5 | 1,684 | 4/25/2017 | |
2.16.2 | 1,617 | 4/20/2017 | |
2.16.0 | 1,696 | 4/17/2017 | |
2.15.5 | 2,075 | 4/6/2017 | |
2.15.2 | 2,039 | 3/29/2017 | |
2.13.1 | 1,970 | 3/7/2017 | |
2.13.0 | 1,999 | 3/6/2017 | |
2.12.1 | 1,989 | 2/14/2017 | |
2.12.0 | 1,964 | 2/13/2017 | |
2.11.3 | 1,970 | 2/7/2017 | |
2.11.2 | 1,958 | 1/25/2017 | |
2.11.1 | 1,950 | 1/24/2017 | |
2.11.0 | 1,935 | 1/23/2017 | |
2.10.2 | 1,952 | 1/4/2017 | |
2.10.1 | 1,928 | 1/4/2017 | |
2.10.0 | 2,054 | 1/3/2017 | |
2.9.3 | 1,968 | 12/15/2016 | |
2.9.2 | 1,973 | 12/14/2016 | |
2.9.1 | 2,070 | 12/13/2016 | |
2.9.0 | 1,998 | 12/12/2016 | |
2.8.2 | 2,045 | 11/28/2016 | |
2.8.1 | 2,005 | 11/24/2016 | |
2.8.0 | 2,042 | 11/22/2016 | |
2.7.3 | 2,335 | 11/8/2016 | |
2.7.2 | 2,259 | 11/3/2016 | |
2.7.1 | 2,263 | 11/1/2016 | |
2.7.0 | 2,137 | 10/31/2016 | |
2.6.3 | 2,018 | 10/25/2016 | |
2.6.1 | 1,921 | 10/11/2016 | |
2.6.0 | 2,017 | 10/10/2016 | |
2.5.4 | 2,457 | 9/22/2016 | |
2.5.3 | 2,436 | 9/20/2016 | |
2.5.2 | 2,129 | 9/19/2016 | |
2.5.1 | 2,286 | 9/19/2016 | |
2.5.0 | 2,016 | 9/14/2016 | |
2.4.0 | 1,968 | 8/29/2016 | |
2.3.1 | 1,872 | 8/22/2016 | |
2.3.0 | 1,987 | 8/8/2016 | |
2.2.2 | 1,928 | 7/22/2016 | |
2.2.1 | 1,888 | 7/19/2016 | |
2.2.0 | 1,891 | 7/18/2016 | |
2.1.0 | 2,013 | 6/27/2016 | |
2.0.2 | 1,888 | 6/22/2016 | |
2.0.1 | 1,923 | 6/7/2016 | |
2.0.0 | 1,902 | 6/6/2016 | |
1.9.4 | 2,221 | 5/19/2016 | |
1.9.3 | 1,904 | 5/19/2016 | |
1.9.0 | 1,947 | 5/16/2016 | |
1.8.4 | 1,939 | 5/10/2016 | |
1.8.1 | 2,013 | 5/4/2016 | |
1.8.0 | 2,219 | 4/25/2016 | |
1.7.2 | 1,946 | 4/20/2016 | |
1.7.1 | 1,909 | 4/7/2016 | |
1.7.0 | 2,079 | 4/6/2016 |