Docfx.Glob 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是拉取请求和大多数其他开发活动的默认分支。我们偶尔使用feature/*分支进行史诗级功能开发。

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

Docfx不是定期发布的，新的版本会在维护者认为有足够变更而值得新版本发布时出现。有时我们使用预发布版来自我测试破坏性变更并从社区获取反馈。

路线图

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

• 工作集是正在积极开发的特性。并非这个工作集中的每个特性都会在下一个版本中提交，但它们反映了维护者未来一段时间内关心的要点。

• 待办事项是一组未来某些版本特性候选，但目前并未积极开发。

许可协议

本项目许可协议为MIT。

.NET 基金会

本项目由.NET Foundation支持。

本项目已采用《贡献者契约》中定义的行为准则来明确我们社区期望的行为。更多信息请参阅.NET Foundation行为准则。