Docfx.通用 2.77.0

使用docfx构建您的文档

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

使用docfx构建具有着陆地页、Markdown、.NET API参考文档、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发布。建议使用常规提交。

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

路线图

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

• 工作集正在积极开发的功能。并非所有这些工作集中的功能都将在下一个版本中提交，但它们反映了维护者在即将到来的期间的心情。

• 待办事项是一组功能候选，供未来的发布使用，但目前没有被积极开发。

许可

此项目受MIT许可的许可。

.NET基金

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

此项目采用贡献者公约中定义的行为守则，以明确我们在社区中期望的行为。有关更多信息，请参阅.NET基金会行为守则。