跳转至

🎨 MkDocs Material 功能测试页

本页面展示了所有新添加的 MkDocs Material 主题功能,每个功能都有源码示例和实际效果展示。


1. Admonition 提示框

源码

Markdown
!!! note "笔记"
    这是一个笔记提示框,用于补充说明。

!!! tip "技巧"
    这是一个技巧提示框,分享实用建议。

!!! warning "警告"
    这是一个警告提示框,提醒注意事项。

!!! danger "危险"
    这是一个危险提示框,标记高风险操作。

!!! info "信息"
    这是一个信息提示框,提供相关信息。

!!! success "成功"
    这是一个成功提示框,表示操作成功。

!!! question "问题"
    这是一个问题提示框,用于提出疑问。

!!! example "示例"
    这是一个示例提示框,展示用法。

效果展示

笔记

这是一个笔记提示框,用于补充说明。

技巧

这是一个技巧提示框,分享实用建议。

警告

这是一个警告提示框,提醒注意事项。

危险

这是一个危险提示框,标记高风险操作。

信息

这是一个信息提示框,提供相关信息。

成功

这是一个成功提示框,表示操作成功。

问题

这是一个问题提示框,用于提出疑问。

示例

这是一个示例提示框,展示用法。


index.md 说明页

Markdown
已在该目录下创建了美观的 index.md 说明页,增强了阅读体验。

主要特性:

卡片式导航:将基础篇与进阶篇的内容核心点以卡片形式展示,方便快速选择。
知识图谱:使用 Mermaid 绘制了知识层级图,直观展示知识点关联。
场景速查表:提供了常见业务场景与对应函数的速查表。
学习建议:添加了针对学习难点的建议提示。
元数据:添加了 description 用于SEO和预览。

2. 可折叠提示框

源码

Markdown
??? note "点击展开笔记"
    这是一个可折叠的提示框,默认收起状态。

    可以包含多行内容。

???+ tip "默认展开的技巧"
    这个提示框默认是展开的(注意 `+` 号)。

效果展示

点击展开笔记

这是一个可折叠的提示框,默认收起状态。

可以包含多行内容。

默认展开的技巧

这个提示框默认是展开的(注意 + 号)。


3. 代码块功能

3.1 带标题和行号的代码

源码

Markdown
```python title="hello.py" linenums="1"
def greet(name: str) -> str:
    """向用户问好"""
    return f"Hello, {name}!"

if __name__ == "__main__":
    print(greet("World"))
```

效果展示

hello.py
1
2
3
4
5
6
def greet(name: str) -> str:
    """向用户问好"""
    return f"Hello, {name}!"

if __name__ == "__main__":
    print(greet("World"))

3.2 代码高亮特定行

源码

Markdown
```python hl_lines="2 3"
def calculate():
    x = 10  # 这行会高亮
    y = 20  # 这行也会高亮
    return x + y
```

效果展示

Python
def calculate():
    x = 10  # 这行会高亮
    y = 20  # 这行也会高亮
    return x + y

3.3 行内代码高亮

源码

Markdown
使用 `#!python print("Hello")` 来输出文本。

SQL 查询示例:`#!sql SELECT * FROM users WHERE id = 1`

效果展示

使用 print("Hello") 来输出文本。

SQL 查询示例:SELECT * FROM users WHERE id = 1


4. 标签页 (Tabs)

源码

Markdown
=== "Python"

    ```python
    print("Hello, Python!")
    ```

=== "JavaScript"

    ```javascript
    console.log("Hello, JavaScript!");
    ```

=== "SQL"

    ```sql
    SELECT 'Hello, SQL!' AS greeting;
    ```

效果展示

Python
print("Hello, Python!")
JavaScript
console.log("Hello, JavaScript!");
SQL
SELECT 'Hello, SQL!' AS greeting;

5. 任务列表

源码

Markdown
- [x] 已完成的任务
- [x] 另一个完成的任务
- [ ] 待完成的任务
- [ ] 还未开始的任务

效果展示

  • 已完成的任务
  • 另一个完成的任务
  • 待完成的任务
  • 还未开始的任务

6. 表格

源码

Markdown
| 功能 | 描述 | 状态 |
|:-----|:-----|:----:|
| 代码高亮 | 语法着色显示 | ✅ |
| 暗色模式 | 护眼主题切换 | ✅ |
| 搜索功能 | 全站搜索 | ✅ |
| 数学公式 | LaTeX 渲染 | ✅ |

效果展示

功能 描述 状态
代码高亮 语法着色显示
暗色模式 护眼主题切换
搜索功能 全站搜索
数学公式 LaTeX 渲染

7. 数学公式 (MathJax)

7.1 行内公式

源码

Markdown
爱因斯坦的质能方程:\(E = mc^2\)

勾股定理:\(a^2 + b^2 = c^2\)

效果展示

爱因斯坦的质能方程:\(E = mc^2\)

勾股定理:\(a^2 + b^2 = c^2\)

7.2 块级公式

源码

Markdown
\[
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
\]

\[
\sum_{n=1}^{\infty} \frac{1}{n^2} = \frac{\pi^2}{6}
\]

效果展示

\[ \int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi} \]
\[ \sum_{n=1}^{\infty} \frac{1}{n^2} = \frac{\pi^2}{6} \]

8. Mermaid 图表

8.1 流程图

源码

Markdown
```mermaid
flowchart LR
    A[开始] --> B{判断条件}
    B -->|是| C[执行操作A]
    B -->|否| D[执行操作B]
    C --> E[结束]
    D --> E
```

效果展示

flowchart LR
    A[开始] --> B{判断条件}
    B -->|是| C[执行操作A]
    B -->|否| D[执行操作B]
    C --> E[结束]
    D --> E

8.2 时序图

源码

Markdown
```mermaid
sequenceDiagram
    participant 用户
    participant 服务器
    participant 数据库

    用户->>服务器: 发送请求
    服务器->>数据库: 查询数据
    数据库-->>服务器: 返回结果
    服务器-->>用户: 响应数据
```

效果展示

sequenceDiagram
    participant 用户
    participant 服务器
    participant 数据库

    用户->>服务器: 发送请求
    服务器->>数据库: 查询数据
    数据库-->>服务器: 返回结果
    服务器-->>用户: 响应数据

8.3 饼图

源码

Markdown
```mermaid
pie title 编程语言使用占比
    "Python" : 45
    "JavaScript" : 30
    "SQL" : 15
    "其他" : 10
```

效果展示

pie title 编程语言使用占比
    "Python" : 45
    "JavaScript" : 30
    "SQL" : 15
    "其他" : 10

9. Emoji 表情

源码

Markdown
:smile: :heart: :rocket: :star: :fire: :thumbsup:

:white_check_mark: 表示完成
:x: 表示失败
:warning: 表示警告

效果展示

😄 ❤ 🚀 ⭐ 🔥 👍

✅ 表示完成 ❌ 表示失败 ⚠ 表示警告


10. 文本格式化

源码

Markdown
- ^^下划线文本^^
- ~~删除线文本~~
- ==高亮文本==
- ^^**下划线加粗**^^
- H~2~O 表示水的化学式(下标)
- X^2^ 表示 X 的平方(上标)

效果展示

  • 下划线文本
  • 删除线文本
  • 高亮文本
  • 下划线加粗
  • H2O 表示水的化学式(下标)
  • X2 表示 X 的平方(上标)

11. 键盘按键

源码

Markdown
- 复制:++ctrl+c++
- 粘贴:++ctrl+v++
- 保存:++ctrl+s++
- 撤销:++ctrl+z++
- 全选:++ctrl+a++

效果展示

  • 复制:Ctrl+C
  • 粘贴:Ctrl+V
  • 保存:Ctrl+S
  • 撤销:Ctrl+Z
  • 全选:Ctrl+A

12. 脚注

源码

Markdown
这是一段带有脚注的文本[^1],脚注可以包含详细说明[^2]。

[^1]: 这是第一个脚注的内容。
[^2]: 这是第二个脚注,可以包含更详细的说明。

效果展示

这是一段带有脚注的文本1,脚注可以包含详细说明2


13. 定义列表

源码

Markdown
Python
:   一种高级编程语言,以简洁易读著称。

MkDocs
:   一个快速、简单的静态网站生成器。
:   专为项目文档设计。

效果展示

Python
一种高级编程语言,以简洁易读著称。
MkDocs
一个快速、简单的静态网站生成器。
专为项目文档设计。

14. 缩写词

源码

Markdown
HTML 规范由 W3C 维护。

*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium

效果展示

HTML 规范由 W3C 维护。


15. 智能符号

源码

Markdown
- 版权符号:(c)
- 注册商标:(r)
- 商标:(tm)
- 箭头:--> <-- <-->
- 分数:1/4 1/2 3/4
- 省略号:...

效果展示

  • 版权符号:©
  • 注册商标:®
  • 商标:™
  • 箭头:→ ← ↔
  • 分数:¼ ½ ¾
  • 省略号:...

16. 图片增强

源码

Markdown
![图片描述](https://via.placeholder.com/400x200/5c6bc0/ffffff?text=示例图片){ loading=lazy }

效果展示

示例图片


🎉 总结

以上功能都已在您的 MkDocs 站点中启用。您可以:

  1. 切换主题:点击右上角的 图标切换亮/暗模式
  2. 使用搜索:按 S 或点击搜索框进行全站搜索
  3. 代码复制:鼠标悬停在代码块上,点击复制按钮
  4. 返回顶部:向下滚动后,点击右下角的返回顶部按钮

本页面由 Claude 创建,用于测试 MkDocs Material 主题的各项功能。


  1. 这是第一个脚注的内容。 

  2. 这是第二个脚注,可以包含更详细的说明。