8

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

官方文档仅对如何创建新模板进行了高级描述。我以前从未使用过模板语言，所以如果可能的话，我现在想避免这种情况。

我的问题是：我怎样才能对默认主题进行小幅调整，比如一些 CSS 更改，或者添加外部资源（比如 font awesome）？

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

一个使用自定义主题或模板的项目的链接已经非常有用。docfx repo有一个docfx.website.themes文件夹，我相信默认模板也在那里，但我真的不知道我必须提供哪些文件才能推出自己的文件。

4

1 回答 1

23
  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 可能会在发布新版本时更新其嵌入式模板。因此，如果您在自定义模板中覆盖或依赖该模板，请确保重新导出该模板。

于 2016-05-21T10:36:37.103 回答