快来美化你的MKDocs吧

简介: 快来美化你的MKDocs吧

前言


前面我们介绍过 MKDocs 的基础用法(MKDocs 入门)。很多同学都表示非常香,但是默认的主题不够美观,虽然我们可以通过内置的 readthedocs 主题来改善,但是还不够美,今天我们就一起来尝试一款比较现代的 MKDocs 主题 material


关于 material


material 主题是基于 MKDocs 的面向现代化技术文档网站的一个主题,非常的漂亮。


网络异常,图片无法展示
|


呆猫


首先我们 mkdocs init 初始化一个 MKDocs 项目。


网络异常,图片无法展示
|


然后我们 pip install mkdocs-material 下载 material 主题。


最后我们启动项目时指定主题为 material


网络异常,图片无法展示
|


网络异常,图片无法展示
|


网络异常,图片无法展示
|


怎么样,相比 readthedocsmaterial 的效果还是比较清新现代的。


material 配置


通常我们会将主题配置到 mkdocs.yaml 中,而非命令行指定。

所以我们需要将主题和 markdown 的高亮配置写到配置文件中。


site_name: My Docs
theme:
  name: material
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
复制代码


配置主题到 mkdocs.yaml 后,启动服务不需要指定主题了。直接 mkdocs serve 即可


代码高亮和标题


material 不但支持代码高亮还支持代码标题。


```python title='demo.py'
def sayhi():
    return "hi,Python全栈开发"
```
复制代码


网络异常,图片无法展示
|


不但如此,material 还支持代码自由注释,并且交互良好。


```python title='demo.py'
def sayhi():
    return "hi,Python全栈开发" # (1)
```
1. 这是我自由注释的内容,欢迎关注我的公众号。
复制代码


网络异常,图片无法展示
|


好看的提示框


提示框的配置:


markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
theme:
  icon:
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
复制代码


md 内容:


!!! note "这是 note 类型的提示框"
提示:更多精彩内容记得关注我啊
!!! success "这是 success 类型的提示框"
成功!
!!! failure "这是 failure 类型的提示框"
失败!
!!! bug "这是 bug 类型的提示框"
发现一个 bug,请尽快修复!
复制代码


网络异常,图片无法展示
|


对于提示框中很多内容的场景,该如何处理呢?material 支持提示框的折叠。


!!! --> ??? 即可。


md 内容:


??? note "这是 note 类型的提示框"
提示:更多精彩内容记得关注我啊
    第二行
    第三行
    第四行
    第五行
    ...
复制代码


网络异常,图片无法展示
|


更多内容:material 官方文档


最后


以上 material 只展示了部分功能,material 还支持单词缩写、按钮、数据表格、mermaid、锚、字符格式化、EmojiIcon、图片、数学公式等。总之,很强大。

最后,希望我的分享能够对你有所帮助!


相关文章
|
关系型数据库 Linux PostgreSQL
Linux centos8 docker中安装postgresql12.4及远程访问设置
Linux centos8 docker中安装postgresql12.4及远程访问设置
1776 0
|
Shell
百度搜索:蓝易云【Ros终端出现找不到bash: /home/***/devel/setup.bash: 没有那个文件或目录怎么办?】
通过以上步骤,您应该能够解决 "找不到bash: /home/ *** /devel/setup.bash: 没有那个文件或目录" 错误,并正常使用ROS环境。如果问题仍然持续存在,建议您检查您的ROS安装和配置,并参考ROS官方文档或ROS社区寻求帮助。
1254 0
|
API 调度 C语言
C++实现进程调度模拟程序——哲学家进餐问题
C++实现进程调度模拟程序——哲学家进餐问题
727 0
|
前端开发
饿了么el-dialog自定义内容以及el-dialog自定义样式
饿了么el-dialog自定义内容以及el-dialog自定义样式
1411 0
|
Shell 程序员 开发工具
码云代码托管平台
码云代码托管平台
|
人工智能 文字识别 异构计算
SmolDocling:256M多模态小模型秒转文档!开源OCR效率提升10倍
SmolDocling 是一款轻量级的多模态文档处理模型,能够将图像文档高效转换为结构化文本,支持文本、公式、图表等多种元素识别,适用于学术论文、技术报告等多类型文档。
1229 1
SmolDocling:256M多模态小模型秒转文档!开源OCR效率提升10倍
|
人工智能 前端开发 Unix
使用tree命令把自己的代码归类文件目录的方法-优雅草央千澈以优雅草AI智能功能为例给大家展示tree命令实际用法
使用tree命令把自己的代码归类文件目录的方法-优雅草央千澈以优雅草AI智能功能为例给大家展示tree命令实际用法
688 29
使用tree命令把自己的代码归类文件目录的方法-优雅草央千澈以优雅草AI智能功能为例给大家展示tree命令实际用法
|
人工智能 数据可视化 Linux
本地部署Stable Diffusion分享
Stable Diffusion是一种潜在扩散模型(Latent Diffusion Model),能够从文本描述中生成详细的图像。它还可以用于图像修复、图像绘制、文本到图像和图像到图像等任务。简单地说,我们只要给出想要的图片的文字描述在提Stable Diffusion就能生成符合你要求的逼真的图像!
1569 17
|
存储 编译器 调度
[计算机组成原理(谭志虎 微课版)]第一章 计算机系统概述(课后习题[习题1]+答案解析)
[计算机组成原理(谭志虎 微课版)]第一章 计算机系统概述(课后习题[习题1]+答案解析)
|
Java Maven 开发工具
maven安装配置教程-Windows(保姆级教程)
maven安装配置教程-Windows(保姆级教程)
2111 0
maven安装配置教程-Windows(保姆级教程)

热门文章

最新文章