Docfx.Build.Common 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的最新发展保持同步。

贡献

有疑问和一般讨论，请使用讨论区。报告错误和提出功能建议，请使用问题。

欢迎通过pull请求、标记为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分支是默认的分支，用于pull请求和大多数其他开发活动。我们偶尔使用feature/*分支进行大型功能开发。

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

Docfx不是一个按常规节奏发布的，当维护者看到足够多的更改，值得发布新版本时，才会发布新版本。有时我们使用预发布来测试破坏性更改并从社区获取反馈。

路线图

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

• 工作集是正在积极开发的功能。并非这个桶中的每个功能都将在下一个版本中提交，但它们反映了维护者在未来一段时间的工作重点。

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

许可证

本项目采用MIT许可。

.NET 基金会

本项目由.NET 基金会支持。

本项目采纳了贡献者公约设定的行为准则，以明确我们社区中的预期行为。更多详细信息请参阅.NET 基金会行为准则。