首页 文章

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

提问于
浏览
3

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

official documentation仅提供了有关如何创建新模板的高级描述 . 如果可能的话,我现在想避免这样做 .

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

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

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

1 回答

  • 14
    • 导出模板:

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

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

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

    • CSS更改:修改 styles\docfx.cssstyles\main.css

    • 使用自定义模板:

    • 运行 docfx -t _exported_templates\default ,它将使用您的自定义模板!

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

相关问题