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

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

Docfx 不会以常规的节奏发布，新的版本在维护者看到足够多的变化来支持新版本时才会出现。有时我们使用预发布版来品尝破坏性更改并获得社区的反馈。

路线图

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

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

• 待办事项 是一些未来版本的特征候选，但目前并没有积极工作。

许可

本项目采用 MIT 许可证。

.NET 基金会

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

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