如何在Material for MkDocs中实现Windows与Mac命令切换功能?
在Material for MkDocs中实现多操作系统命令切换效果
Material for MkDocs自带的选项卡功能就能实现和Django文档一样的多OS命令切换,具体操作步骤如下:
1. 配置必要的Markdown扩展
首先在项目根目录的mkdocs.yml里启用pymdownx.tabbed扩展,这是实现选项卡的核心:
markdown_extensions: - pymdownx.tabbed: alternate_style: true # 开启后选项卡样式更贴近Django的风格
2. 编写带选项卡的命令内容
用===标记选项卡标题,下面缩进后放对应操作系统的命令代码块,示例如下:
=== "Windows" ```powershell python manage.py runserver ``` === "macOS" ```bash python3 manage.py runserver ``` === "Linux" ```bash python3 manage.py runserver ```
渲染后就会出现可切换的选项卡,用户点击不同标签就能看到对应系统的命令。
3. 自定义样式(可选)
如果想让样式更接近Django文档的视觉效果,可以添加自定义CSS:
- 在
docs/css目录下创建custom.css文件,写入以下样式:
/* 调整选项卡边框和背景,贴近Django风格 */ .md-tabs__list { border-bottom: 1px solid #e1e4e5; } .md-tabs__item { margin-right: 8px; } .md-tabs__link { padding: 8px 16px; border-radius: 4px 4px 0 0; border: 1px solid transparent; } .md-tabs__link--active { border-color: #e1e4e5; border-bottom-color: #fff; background-color: #fff; }
- 在
mkdocs.yml中引用这个自定义CSS:
extra_css: - css/custom.css
内容的提问来源于stack exchange,提问作者AugustusCaesar
相关产品推荐
相关产品推荐

