如何自定义 Docfx 文档(主题或模板)?
How can I customize Docfx documentation (themes or templates)?
我刚开始使用 Docfx 并设置了一些基本的概念文档。现在我想对主题做一些调整(公司标志,也许是一些字体变化等)小东西。
official documentation 仅对如何创建新模板进行了高级描述。我以前从未使用过模板语言,所以我想尽可能避免使用它。
我的问题是:我如何对默认主题进行小幅调整,例如一些 CSS 更改以及可能添加外部资源(如字体真棒)?
我是否必须创建一个完整的模板(或其中的一部分),或者我能否以某种方式包含一个 CSS 文件?该文档提到了一个 theme
选项,但到目前为止,我还没有找到可供学习的示例或现有主题。
对使用自定义主题或模板的项目仅 link 就已经很有帮助了。 docfx repo 有一个 docfx.website.themes
文件夹,我相信默认模板也在那里,但我无法真正弄清楚我必须提供哪些文件才能自己滚动。
- 导出模板:
- 运行
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.
我刚开始使用 Docfx 并设置了一些基本的概念文档。现在我想对主题做一些调整(公司标志,也许是一些字体变化等)小东西。
official documentation 仅对如何创建新模板进行了高级描述。我以前从未使用过模板语言,所以我想尽可能避免使用它。
我的问题是:我如何对默认主题进行小幅调整,例如一些 CSS 更改以及可能添加外部资源(如字体真棒)?
我是否必须创建一个完整的模板(或其中的一部分),或者我能否以某种方式包含一个 CSS 文件?该文档提到了一个 theme
选项,但到目前为止,我还没有找到可供学习的示例或现有主题。
对使用自定义主题或模板的项目仅 link 就已经很有帮助了。 docfx repo 有一个 docfx.website.themes
文件夹,我相信默认模板也在那里,但我无法真正弄清楚我必须提供哪些文件才能自己滚动。
- 导出模板:
- 运行
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.