如何在mkdocs中移除Previous、Next(上/下页)导航按钮
MkDocs 移除 Previous/Next 导航按钮正规方案
以下方案均为官方支持的合规实现,无需修改主题源码:
针对 MkDocs 原生默认主题 / ReadTheDocs 主题
这两类主题原生自带相关配置项,直接修改你的 mkdocs.yml 配置文件即可:
theme: name: mkdocs # 若使用ReadTheDocs主题则改为 name: readthedocs # 直接关闭上下页按钮展示 prev_next_buttons_location: none
针对 Material for MkDocs 主题
全局隐藏
直接在配置文件中添加如下配置:
theme: name: material features: # 关闭底部导航栏(包含上下页按钮) - navigation.footer: false
单页隐藏
如果只需要特定页面不展示上下页按钮,在对应 Markdown 文件的顶部前言区域添加配置即可:
--- hide: - prev - next --- 页面正文内容
其他第三方主题通用方案
如果使用的小众主题没有对应的内置配置,可以使用 MkDocs 官方支持的自定义样式注入功能实现,不属于hack方案:
- 第一步:在
mkdocs.yml中配置自定义CSS路径
extra_css: - css/extra.css
- 第二步:在项目
docs/css目录下新建extra.css文件,添加对应样式隐藏按钮即可,不同主题的按钮类名可通过浏览器开发者工具查询,示例如下:
/* 通用匹配上下页按钮容器隐藏,可根据实际主题类名调整 */ .prev-next-area { display: none; }
你找到的早期Issue是多年前MkDocs生态不完善时期的反馈,目前主流主题都已经支持正规配置实现该需求。
内容的提问来源于stack exchange,提问作者Chris Bolton
相关产品推荐
相关产品推荐

