material 基础配置
默认的主题相信您在建站的时候已经看过了,如果您希望接着使用默认主题,那么接下来的内容部分可能已不适用;
本网站使用 material 主题,如果您希望使用同样的主题,那么可以接着往下看:
参考 mkdocs 官方文档 配置,下面仅分享自己用到的内容,如有其他需求可以查询上述文档。
设置 material 主题♪
在主文件夹下的 mkdocs.yml 中添加如下内容(之后不特殊提及均默认为对此文件进行修改):
即可使用 material 主题。
Getting Started♪
更改图标♪
图标分为两类:logo 和 favicon。前者为网页中左上角的图标;后者为网站的缩略标志。
需要如下代码:
其中 logo_url 为 logo 图片的 url,favicon_url 为 favicon 图片的 url。
导航♪
顶栏导航♪
如果需要顶栏导航(内容为 nav 的最外层目录内容),则需要如下代码:
如果需要固定顶栏,在此基础上还需添加:
标题后的锚点符号♪
如需自定义,则需要加入以下代码(例子中,符号设定为 ♪ ):
若无特殊设定,默认为 ¶ 符号。
返回最上部按钮♪
可在上翻时弹出 Back to top 按钮,需要如下代码:
插件(plugins)♪
搜索插件♪
插入如下语句:
即可开启插件。不过由于该插件一般为自动添加,故通常情况下不需要该语句。
启用搜索联想♪
需要如下代码:
markdown 与 html 的混用♪
需要添加如下语句: