Docfx.Build 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 and 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 Releases。鼓励使用常规提交。

Docfx不是按照常规周期发布的，新版本出现在维护者认为有足够更改值得新发布时。有时我们使用预发布版来自示范破坏性更改并从社区获取反馈。

路线图

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

• 工作集是正在积极工作的功能。这个桶中不是每个功能都会在下一个版本中实现，但它们反映了维护者在未来的想法。

• 待办事项是一组未来发行中的功能候选者，但目前不是积极工作的。

许可

该项目受MIT许可证的约束。

.NET 基金会

该项目由.NET Foundation支持。

本项目采用贡献者公约中定义的行为准则，以阐明我们社区中期望的行为。更多信息请参阅.NET Foundation行为准则。