Docfx.HtmlToPdf 2.74.1

使用 docfx 构建您的文档

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

使用 docfx 构建您的技术文档网站，包括着陆页面、Markdown、.NET、REST API 等文档。

入门

1. 将 docfx 安装为全局工具

   dotnet tool install -g docfx
   

2. 创建并本地启动网站

   docfx init -q
   docfx build docfx_project\docfx.json --serve
   

3. 访问 https://127.0.0.1:8080 查看示例网站。

更多信息，请参阅 入门。

贡献

在 讨论 中提问并进行一般讨论。使用 问题 报告错误和提议功能。

我们欢迎通过拉取请求进行代码贡献，标记为 help-wanted 的问题是开始贡献代码的好起点。

先决条件

• 安装 Visual Studio 2022 (Community 或更高版本) 并确保您有最新的更新。
• 安装 .NET SDK 6.x、7.x 和 8.x。
• 安装 NodeJS (18.x.x)。
• 可选：在 Windows 上安装 wkhtmltopdf 以测试 PDF，使用 choco install wkhtmltopdf。

构建和测试

• 在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已经过渡到.NET Foundation项目。Microsoft Learn不再使用docfx，并且自2022年11月起不打算支持该项目。

Docfx计划继续作为一个社区驱动的项目。我们希望生产未来的发行版，加入新功能和改进，以支持现有的和新的用例。我们也希望邀请任何感兴趣的各方参与这个项目。如果您想联系社区团队，请开启一个讨论线程。

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

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

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

许可协议

本项目采用MIT许可证。

.NET 基金会

本项目由.NET Foundation支持。

本项目采用了Contributor Covenant制定的行为准则，以明确我们社区中预期的行为。有关更多信息，请参阅.NET Foundation行为准则。