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

Question

我刚开始使用Docfx并设置了一些基本的概念文档.现在我想对主题进行一些调整(公司徽标,也许是一些字体更改等).

在官方文档只给出了如何创建一个新的模板高级描述.我之前从未使用过模板语言,所以如果可能的话,我现在想避免使用它.

我的问题是:我如何对默认主题进行小幅调整,比如一些CSS更改以及可能添加外部资源(如字体真棒)？

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

仅使用自定义主题或模板的项目链接已经非常有用.该docfx回购有一个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可能在发布新版本时更新其嵌入式模板.因此,如果您在自定义模板中覆盖或依赖该模板,请务必重新导出模板.