Docfx.Build.TableOfContents 2.71.0
前缀已保留
建议的替代方案
dotnet add package Docfx.Build.TableOfContents --version 2.71.0
NuGet\Install-Package Docfx.Build.TableOfContents -Version 2.71.0
该命令旨在在Visual Studio的包管理器控制台中使用，因为它使用了NuGet模块的Install-Package版本。
<PackageReference Include="Docfx.Build.TableOfContents" Version="2.71.0" />
对于支持PackageReference的项目，将此XML节点复制到项目文件中以引用该包。
paket add Docfx.Build.TableOfContents --version 2.71.0
NuGet团队不支持此客户端。请联系其维护者以获取支持。
#r "nuget: Docfx.Build.TableOfContents, 2.71.0"
#r指令可以在F#交互式和Polyglot笔记本中使用。将其复制到交互式工具或脚本的源代码中，以引用包。
// Install Docfx.Build.TableOfContents as a Cake Addin #addin nuget:?package=Docfx.Build.TableOfContents&version=2.71.0 // Install Docfx.Build.TableOfContents as a Cake Tool #tool nuget:?package=Docfx.Build.TableOfContents&version=2.71.0
NuGet团队不支持此客户端。请联系其维护者以获取支持。
使用docfx构建您的文档
使用docfx构建以下技术文档网站，包括着陆页面、Markdown、.NET、REST API等的API参考文档。
⚠️⚠️⚠️ 注意 ⚠️⚠️⚠️
DocFX正在过渡到.NET基金会，成为官方.NET项目！
- DocFX团队正在努力改进主分支。这将向项目中引入新特性和错误修复，移除一些不再必要的较旧代码和功能，并更新依赖项以及简化项目结构。请关注路线图。
- 由于网站结构的变化[1]，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（社区版或更高版本）并确保您有最新的更新。
- 安装6.x和7.x版本的.NET Core SDK。
- 安装NodeJS（18.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请求和大多数其他开发活动的默认分支。我们偶尔使用feature/*分支来进行史诗级功能开发。
发布基于稳定的main分支提交，使用GitHub发布。鼓励使用常规提交。
Docfx不是按常规节奏发布的，版本在维护者认为有足够的更改需要进行新发布时到达。有时我们会使用预发布版来测试破坏性更改并从社区获取反馈。
路线图
我们使用里程碑来沟通即将到来的docfx更改。
许可证
此项目根据MIT许可证授权。
.NET基金会
此项目由.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
- Docfx.Build.Common (>= 2.71.0)
- Docfx.Common (>= 2.71.0)
- Docfx.DataContracts.Common (>= 2.71.0)
- Docfx.Plugins (>= 2.71.0)
- Docfx.YamlSerialization (>= 2.71.0)
-
net7.0
- Docfx.Build.Common (>= 2.71.0)
- Docfx.Common (>= 2.71.0)
- Docfx.DataContracts.Common (>= 2.71.0)
- Docfx.Plugins (>= 2.71.0)
- Docfx.YamlSerialization (>= 2.71.0)
-
net8.0
- Docfx.Build.Common (>= 2.71.0)
- Docfx.Common (>= 2.71.0)
- Docfx.DataContracts.Common (>= 2.71.0)
- Docfx.Plugins (>= 2.71.0)
- Docfx.YamlSerialization (>= 2.71.0)
NuGet 包
此包没有被任何 NuGet 包使用。
GitHub 仓库
此包没有被任何流行的 GitHub 仓库使用。