Theme
默认渲染器使用一个handlebars模板,用于渲染markdown文件,并mdBook二进制文件包含默认主题.
主题是完全可定制的,您可以通过在根目录src
旁边,新建一个theme
文件夹,在其中选择性地添加文件名称,覆盖主题的任意文件。
以下是您可以覆盖的文件: | 描述 |
---|---|
index.hbs | hbs模板. |
book.css | 是输出中使用的样式。如果要更改图书的设计,可能是您要修改的文件。有时与index.hbs 一起,当你想从根本上改变布局. |
book.js | 主要用于添加客户端功能,如隐藏/取消隐藏侧边栏,更改主题,… |
highlight.js | 是用于突出显示代码片段的JavaScript,您不需要修改它. |
highlight.css | 是用于代码突出显示的主题 |
favicon.png | 将使用的favicon |
通常,当您想要调整主题时,您不需要覆盖所有文件。如果您只需要更改css样式表,那么覆盖所有其他文件是没有意义的。由于自定义文件优先于内置文件,那以后的新的修补程序/功能,你都更新不了。
注意: 覆盖文件时,可能会破坏某些功能。因此,我建议使用默认主题中的文件作为模板,只添加/修改您需要的内容。您可以使用mdbook init --theme
命令自动将默认主题自动复制到源目录中,只需删除您不想覆盖的文件.
当前内容版权归 chinanf-boy 或其关联方所有,如需对内容或内容相关联开源项目进行关注与资助,请访问 chinanf-boy .