Docfx.Build.ResourceFiles 2.71.0
前缀已预留
建议的替代方案
dotnet add package Docfx.Build.ResourceFiles --version 2.71.0
NuGet\Install-Package Docfx.Build.ResourceFiles -Version 2.71.0
此命令旨在在 Visual Studio 的包管理器控制台中使用，因为它使用 NuGet 模块的 Install-Package 版本。
<PackageReference Include="Docfx.Build.ResourceFiles" Version="2.71.0" />
对于支持 PackageReference 的项目，请将此 XML 节点复制到项目文件中，以引用软件包。
paket add Docfx.Build.ResourceFiles --version 2.71.0
NuGet 团队不提供对客户端的支持。请联系其 维护者 以获取支持。
#r "nuget: Docfx.Build.ResourceFiles, 2.71.0"
#r 指令可用于 F# Interactive 和 Polyglot Notebooks。将此内容复制到交互式工具或脚本的源代码中，以引用软件包。
// Install Docfx.Build.ResourceFiles as a Cake Addin #addin nuget:?package=Docfx.Build.ResourceFiles&version=2.71.0 // Install Docfx.Build.ResourceFiles as a Cake Tool #tool nuget:?package=Docfx.Build.ResourceFiles&version=2.71.0
NuGet 团队不提供对客户端的支持。请联系其 维护者 以获取支持。
使用 docfx 打造文档
使用 docfx 打造技术文档站点，包含着陆页、Markdown、.NET、REST API 等的 API 引用文档。
⚠️⚠️⚠️ 通告 ⚠️⚠️⚠️
DocFX 正在迁移到 .NET Foundation，成为官方 .NET 项目！
- DocFX 团队正在改进主分支。这将向项目引入新功能和错误修复，删除一些不再需要的旧代码和功能，同时更新依赖项并简化项目结构。请关注路线图。
- 由于站点架构变更，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://:8080查看示例网站。
有关更多信息，请参阅入门。
贡献
使用Discuss进行问答和一般讨论。使用Issues提交错误报告和提议功能。
我们欢迎通过pull请求进行代码贡献，标记为help-wanted的问题是开始贡献代码的好候选人。
先决条件
- 安装Visual Studio 2022（Community或更高版本）并确保您有最新的更新。
- 安装.NET Core SDK 6.x和7.x。
- 安装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 Releases。鼓励使用常规提交。
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
- Docfx.Build.Common (>= 2.71.0)
- Docfx.Common (>= 2.71.0)
- Docfx.DataContracts.Common (>= 2.71.0)
- Docfx.Plugins (>= 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)
-
net8.0
- Docfx.Build.Common (>= 2.71.0)
- Docfx.Common (>= 2.71.0)
- Docfx.DataContracts.Common (>= 2.71.0)
- Docfx.Plugins (>= 2.71.0)
NuGet 包
此包未被任何 NuGet 包使用。
GitHub 仓库
此包未被任何流行的 GitHub 仓库使用。