Docfx.Build.SchemaDriven 2.77.0

使用 docfx 创建您的文档

• 入门
• 贡献
• 路线图
• 许可协议
• .NET 基金会

使用 docfx 创建带有着陆页、Markdown、.NET、REST API 等的技术文档站点。

如您所知，docfx 已转为成为 .NET 基金会项目。Microsoft Learn 不再使用 docfx，并且自 2022 年 11 月起不再支持该项目。

docfx 计划继续作为一个社区驱动的项目。我们希望提供具有新功能和改进的未来发布版，以支持现有和新用例。我们也希望邀请任何感兴趣的相关方参与此项目。如果您想联系社区团队，请开启一个讨论线程。

入门

1. 将 docfx 安装为全局工具

   dotnet tool install -g docfx
   

2. 创建并启动本地网站

   docfx init -y
   docfx build docfx_project\docfx.json --serve
   

3. 转到 https://127.0.0.1:8080 查看示例站点。

获取更多信息，请参阅入门指南。

[!TIP] Docfx 将夜间构建发布到GitHub Packages，这使您能够跟上 Docfx 的最新进展。

贡献

有关问题和一般讨论，请使用讨论。关于报告错误和提议新特性，请使用问题。

欢迎通过拉取请求贡献代码。标记为 help-wanted 的问题都是开始贡献代码的好选择。

先决条件

• 安装 Visual Studio 2022（社区版或更高版本），并确保您拥有最新更新。
• 安装 .NET SDK 6.x 和 8.x。
• 安装 NodeJS (20.x.x)。

构建和测试

• 在 templates 目录中构建站点模板。
  • 运行 npm install 以恢复 npm 依赖。
  • 运行 npm run build 以构建模板。
• 运行 dotnet build 构建项目或使用 Visual Studio 构建项目 docfx.sln。
• 运行 dotnet test 测试项目或使用 Visual Studio 测试资源管理器。
  • 运行 git lfs checkout 检出用于快照测试的文件。

分支和发布

默认将 main 分支用作拉取请求和大多数其他开发活动的分支。我们在 Occasionally 使用 feature/* 分支开发重大特性。

发布基于一个稳定的 main 分支提交，使用 GitHub 发布。鼓励使用 常规提交。

Docfx 并不在常规时间周期下发布，当维护者认为有足够的更改进行新发布时，新版本才会出现。有时我们会使用预发布版来测试破坏性更改并从社区获取反馈。

路线图

我们使用 里程碑 来沟通即将到来的 Docfx 变更。

• 工作集 是正在积极开发的功能。这个类别中的每一个功能都可能会在下一个版本中提交，但它们反映了维护者在未来一段时间内的主要思想。

• 待办事项 是未来某个版本的功能候选集，但目前并没有在积极开发。

许可协议

本项目使用MIT许可证。

.NET 基金会

本项目受到.NET 基金会的支持。

本项目已采用.NET 基金会行为准则中定义的行为准则，以阐明我们对社区预期的行为。有关更多信息，请参阅 .NET 基金会行为准则。