Docfx.MarkdigEngine 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 的最新发展。

贡献

使用 讨论 来提问和进行一般性讨论。使用 问题 来报告错误和提出功能。

我们欢迎通过拉取请求进行代码贡献。标记为 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/* 分支来实现史诗级功能开发。

基于使用 GitHub Releases 的稳定 main 分支提交进行发布。鼓励使用 Conventional Commit。

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

路线图

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

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

• 待办事项 是一些未来版本的特征候选，但目前正在积极开发中。

许可协议

本项目采用 MIT 许可。

.NET基金会

本项目由 .NET Foundation 支持。

本项目采纳了贡献者协约的行为准则，以明确我们社区中预期的行为。更多信息请参阅 .NET Foundation 行为准则。