documentation-generation - 如何自定义 Docfx 文档(主题或模板)？

Question

我刚刚开始使用 Docfx 并建立了一些基本的概念文档。现在我想对主题做一些调整(公司标志，也许是一些字体更改等)小东西。

official documentation仅给出如何创建新模板的高级描述。我以前从未使用过模板语言，所以如果可能的话，我想暂时避免这种情况。

我的问题是:我怎样才能对默认主题做一些小的调整，比如一些 CSS 更改，或者添加外部资源(比如 Font Awesome )？

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

仅仅指向使用自定义主题或模板的项目的链接已经非常有帮助。 docfx repo有一个 docfx.website.themes文件夹和默认模板也在那里，我相信，但我无法真正弄清楚我必须提供哪些文件才能推出我自己的文件。

Answer 1

导出模板:

运行 docfx template export default ，然后您将在 _exported_templates\default 中看到默认模板

更改默认模板中的主题，例如:

添加外部资源:修改styles\head.tmpl.partial

CSS 更改:修改 styles\docfx.css或 styles\main.css

使用自定义模板:

运行 docfx -t _exported_templates\default ，这将使用您的自定义模板!

NOTE: It is possible that DocFX updates its embedded templates when releasing new version. So please make sure to re-export the template if you overwrite or dependent on that template in your custom template.