Docfx.App 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 查看示例网站。

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

[!提示] Docfx每天夜间的构建会被发布到GitHub Packages，这允许您随时了解Docfx的最新动态。

贡献

使用讨论来提问和进行一般讨论。使用问题来报告bug和提议功能。

我们欢迎通过pull request进行代码贡献，标记为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 REQUEST_和大多数其他开发活动的默认分支。我们偶尔使用feature/*分支进行史诗级功能开发。

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

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

路线图

我们使用里程碑来沟通即将发生的docfx变化

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

• 待办事项是一组未来版本中的一些功能候选，但目前并没有积极开发。

许可

该项目许可协议为MIT许可。

.NET 基金会

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

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