Docfx.Build.RestApi 2.77.0

使用docfx构建您的文档

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

使用docfx构建技术文档站点，带有落地页、Markdown、.NET、REST API等API参考文档。

如您所 heard，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 以查看示例网站。

有关更多信息，请参阅入门指南。

【提示】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 是 pull 请求以及大多数其他开发活动的默认分支。我们偶尔使用 feature/* 分支进行史诗级功能开发。

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

Docfx 不会按照固定周期发布，新版本将在维护者看到足够的变化，值得发布新版本时出现。有时我们使用预发布版来尝鲜破坏性更改并从社区获得反馈。

路线图

我们使用 里程碑 来传达即将到来的 docfx 变更

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

• 待办事项 是某些未来发布的候选功能集合，但尚未积极工作。

许可

该项目受 MIT 许可证许可。

.NET 基金会

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

该项目采用了由共同承诺定义的代码行为规范，以阐明我们社区中期望的行为。有关更多信息，请参阅 .NET 基金会行为规范。