第 4 章：内容创作¶

# 快速开始

欢迎阅读快速开始指南！这里将帮助你 **在 5 分钟内** 上手本项目。

## 安装

​```bash
pip install my-package
​```

## 基本用法

​```python
from my_package import hello

hello("World")
​```

!!! note "这是一个提示"
    这是普通提示信息，用于补充说明。

!!! info "信息框"
    用于提供额外的背景信息或上下文。

!!! tip "小技巧"
    用于分享最佳实践和实用建议。

!!! warning "警告"
    用于提醒用户注意潜在问题。

!!! danger "危险"
    用于警告可能导致严重后果的操作。

!!! example "示例"
    用于展示代码示例或使用场景。

!!! quote "引用"
    用于引用外部内容或名言。

???+ note "默认展开的弹窗"
    点击标题可以折叠内容。

??? warning "默认折叠的弹窗"
    需要点击才能展开查看内容。

!!! note inline "内联提示"
    这个弹窗会和后面的文字在同一行显示。

​```python
def greet(name: str) -> str:
    """向指定用户打招呼"""
    return f"Hello, {name}!"

print(greet("World"))
​```

​```python title="greet.py"
def greet(name):
    return f"Hello, {name}!"
​```

​```python linenums="1"
def greet(name):
    return f"Hello, {name}!"

def main():
    print(greet("World"))
​```

​```python hl_lines="2 4"
def greet(name):          # 第 1 行
    return f"Hello!"      # 第 2 行（高亮）
                           # 第 3 行
def main():               # 第 4 行（高亮）
    print(greet("World"))
​```

=== "Windows"

    ​```powershell
    mkdir my-project
    cd my-project
    ​```

=== "macOS / Linux"

    ​```bash
    mkdir my-project
    cd my-project
    ​```

| 功能 | 说明 | 状态 |
|:---|:---|:---:|
| 全文搜索 | 支持中英文搜索 | ✅ |
| 暗色模式 | 自动/手动切换 | ✅ |
| 代码复制 | 一键复制代码块 | ✅ |
| 响应式 | 适配手机/平板/桌面 | ✅ |

![图片描述](../assets/screenshot.png)

<!-- 带标题的图片 -->
<figure markdown="span">
  ![图片描述](../assets/screenshot.png)
  <figcaption>图 1：网站首页截图</figcaption>
</figure>

​```mermaid
flowchart TD
    A[开始] --> B{是否已安装 Python？}
    B -->|是| C[安装 MkDocs]
    B -->|否| D[安装 Python]
    D --> C
    C --> E[创建项目]
    E --> F[编写文档]
    F --> G[部署上线]
    G --> H[完成]
​```

**粗体文字**          → 渲染为 **粗体文字**

*斜体文字*            → 渲染为 *斜体文字*

`行内代码`            → 渲染为 `行内代码`

~~删除线~~            → 渲染为 ~~删除线~~

==高亮文字==          → 渲染为 ==高亮文字==

^上标^ 和 ~下标~      → 渲染为上标和下标

H~2~O 和 X^2^         → H₂O 和 X²

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