docfx 2.77.0

使用 docfx 构建您的文档

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

使用 docfx 分析您的技术文档站，包括着陆页、Markdown、.NET、REST API 等 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://: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 分支是拉取请求和其他大多数开发活动的默认分支。我们偶尔会使用 feature/* 分支进行重要功能的开发。

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

Docfx 并不按照常规的时间表发布，新版本会在维护者看到足够的变化，认为有必要发布新版本时出现。有时我们会使用预发布版本来尝试破坏性变更并从社区获取反馈。

路线图

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

• 工作集 是目前正在积极工作的功能。并非这个桶中的所有功能都会在下一个版本中提交，但它们反映了维护者未来一段时期的工作重点。

• 待办事项 是一些未来版本的功能候选者，但目前尚未积极开发。

许可

此项目使用 MIT 许可证。

.NET 基金会

此项目得到 .NET 基金会 的支持。

此项目采用了由贡献者公约定义的代码准则，以明确我们社区中期望的行为。更多信息请参阅 .NET 基金会代码准则。