基础使用¶

学习如何使用 Markdown 编写文档，以及 MkDocs Material 提供的各种扩展功能。

Markdown 基础¶

标题¶

# 一级标题
## 二级标题
### 三级标题
#### 四级标题

文本格式¶

粗体文本、斜体文本、~~删除线~~、行内代码

**粗体文本**、*斜体文本*、~~删除线~~、`行内代码`

列表¶

无序列表：

项目 1
项目 2
子项目 2.1
子项目 2.2
项目 3

- 项目 1
- 项目 2
  - 子项目 2.1
  - 子项目 2.2
- 项目 3

有序列表：

第一步
第二步
第三步

1. 第一步
2. 第二步
3. 第三步

链接和图片¶

链接文本

图片替代文本

[链接文本](https://example.com)
![图片替代文本](https://picsum.photos/400/200)

表格¶

功能	描述	状态
搜索	全文搜索功能
主题	亮色/暗色模式
多语言	国际化支持

| 功能 | 描述 | 状态 |
|------|------|------|
| 搜索 | 全文搜索功能 | :material-check: |
| 主题 | 亮色/暗色模式 | :material-check: |
| 多语言 | 国际化支持 | :material-timer-sand: |

Material 扩展功能¶

提示框 (Admonitions)¶

注意

这是一个提示框，用于突出显示重要信息。

警告

这是一个警告框，用于提醒用户注意潜在问题。

提示

这是一个技巧框，用于分享有用的技巧。

危险

这是一个危险框，用于警告严重的风险。

!!! note "注意"
    这是一个提示框，用于突出显示重要信息。

!!! warning "警告"
    这是一个警告框，用于提醒用户注意潜在问题。

!!! tip "提示"
    这是一个技巧框，用于分享有用的技巧。

!!! danger "危险"
    这是一个危险框，用于警告严重的风险。

可折叠的提示框：

这是什么？

点击即可展开查看答案！

??? question "这是什么？"
    点击即可展开查看答案！

代码块¶

基础代码块¶

def hello_world():
    print("Hello, MkDocs!")

带行号的代码块¶

def fibonacci(n):
    if n <= 1:
        return n
    return fibonacci(n-1) + fibonacci(n-2)

for i in range(10):
    print(f"F({i}) = {fibonacci(i)}")

高亮特定行¶

def greet(name):
    # 这一行会被高亮
    message = f"Hello, {name}!"
    return message

# 这一行也会被高亮
print(greet("World"))

标签页 (Tabs)¶

PythonJavaScriptJava

print("Hello, Python!")

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

System.out.println("Hello, Java!");

=== "Python"

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

=== "JavaScript"

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

=== "Java"

    ```java
    System.out.println("Hello, Java!");
    ```

任务列表¶

已完成任务
另一个已完成任务
未完成任务
另一个未完成任务

- [x] 已完成任务
- [x] 另一个已完成任务
- [ ] 未完成任务
- [ ] 另一个未完成任务

表情符号¶

:smile: :rocket: :star: :heart: :thumbsup:

键盘按键¶

按下 Ctrl+Alt+Del 组合键

按下 Cmd+C 复制

按下 ++ctrl+alt+delete++ 组合键

按下 ++cmd+c++ 复制

内容标注¶

Text can be {--deleted--} and replacement text {++added++}.

This is {highlighted} text.

Text can be subscripted₂ and superscripted².

Text can be {--deleted--} and replacement text {++added++}.

This is {==highlighted==} text.

Text can be subscripted~2~ and superscripted^2^.

脚注¶

这是一个带有脚注的句子¹。

这是一个带有脚注的句子[^1]。

[^1]: 这是脚注的内容。

缩写¶

The HTML specification is maintained by the W3C.

The HTML specification is maintained by the W3C.

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

这是脚注的内容。 ↩