docfx

使用docfx构建您的文档

• 入门
• 贡献
• 路线图
• 执照
• .NET基金会

使用docfx构建您的技术文档网站，使用着陆页，降价，.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\”>

    docfx init -y
   docfx build docfx _project\\ docfx .json --serve
   

3. 转到https：// localhost：8080查看样本站点。

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

提示

docfx每晚发布到GitHub软件包，这使您可以随时了解docfx中的最新发展。

贡献

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

我们欢迎通过拉动请求，标记为help-wanted问题是开始贡献代码的好候选人。

先决条件

• 安装Visual Studio 2022（社区或更高），并确保您有最新的更新。
• 安装.NET SDK 8.x和9.x.
• 安装nodejs（22.xx）。

构建和测试

• 在templates目录中构建站点模板：
  • 运行npm install以还原NPM依赖关系。
  • 运行npm run build以构建模板。
• 运行dotnet build以构建项目或使用Visual Studio构建docfx .sln 。
• 运行dotnet test以测试项目或使用Visual Studio Test Explorer。
  • 运行git lfs checkout到结帐文件以进行快照测试

分支和释放

main分支是拉动请求和大多数其他开发活动的默认分支。我们有时会使用feature/*分支进行史诗特征开发。

版本基于使用GitHub释放的稳定的main分支提交。鼓励使用常规提交。

docfx并未在常规节奏下发布，当维护者看到足够的更改需要新版本时，新版本就会到达。有时，我们会使用预发行来破坏狗食的变化，并从社区获得反馈。

路线图

我们使用里程碑来传达即将进行的更改docfx ：

• 工作集是积极工作的功能。并非该存储桶中的每个功能都会在下一个版本中发挥作用，但它们在接下来的时期反映了维护者的头脑。

• 积压是一组未来发行版的特征候选人，但并未积极进行。

执照

该项目已根据MIT许可获得许可。

.NET基金会

该项目得到了.NET基金会的支持。

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