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

Question

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

官方文档仅提供了如何创建新模板的高级描述。我以前从未使用过模板语言，所以如果可能的话，我想暂时避免使用。

我的问题是：如何对默认主题进行小调整，例如一些 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 在发布新版本时可能会更新其嵌入模板。因此，如果您在自定义模板中覆盖或依赖该模板，请确保重新导出该模板。

Answer 2

通过设置“template”docfx.json，如果模板内的文件名匹配，最后一个模板将覆盖第一个模板。因此，为您的模板创建一个新文件夹，将更改的文件复制到其中，遵循原始模板的文件夹结构就足够了。将自定义模板包含在配置文件中。需要“默认”模板。看示例模板default(zh-cn)