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

时间:2016-03-17 16:23:29

标签: documentation-generation docfx

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

official documentation仅提供有关如何创建新模板的高级描述。我之前从未使用过模板语言,所以如果可能的话,我现在想避免使用它。

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

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

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

1 个答案:

答案 0 :(得分:15)

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

    注意:DocFX可能会在发布新版本时更新其嵌入式模板。因此,如果您在自定义模板中覆盖或依赖该模板,请务必重新导出模板。