如何自定义 Docfx 文档（主题或模板）？

Question

我刚开始使用 Docfx 并设置了一些基本的概念文档。现在我想对主题进行一些调整（公司徽标，也许是一些字体更改等）。小东西。

official documentation 仅对如何创建新模板进行了高级描述。我以前从未使用过模板语言，所以如果可能的话，我想暂时避免使用。

我的问题是：如何对默认主题进行小幅调整，例如一些 CSS 更改，或者添加外部资源（例如 font awesome）？

我必须创建一个完整的模板（或其中的一部分）还是我可以以某种方式包含一个 CSS 文件？文档中提到了 theme 选项，但到目前为止，我还没有找到可以学习的示例或现有主题。

一个使用自定义主题或模板的项目的链接已经非常有用。 docfx repo 有一个 docfx.website.themes 文件夹，我相信默认模板也在其中，但我真的不知道我必须提供哪些文件才能自己滚动。

Answer 1

1. 导出模板：
   • 运行docfx template export default，然后你会在_exported_templates\default看到默认模板
2. 更改默认模板中的主题，例如：
   • 添加外部资源：修改styles\head.tmpl.partial
   • CSS 更改：修改styles\docfx.css 或styles\main.css
3. 使用自定义模板：
   • 运行docfx -t _exported_templates\default，它将使用您的自定义模板！

注意：DocFX 可能会在发布新版本时更新其嵌入的模板。因此，如果您在自定义模板中覆盖或依赖该模板，请确保重新导出该模板。