Markdown 语法使用指南

Markdown 是一种轻量级标记语言,用简单的符号实现排版效果,易读易写。

目录


基础语法

1. 标题

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

2. 段落与换行

  • 段落:直接写文字,段落之间空一行
  • 换行:行尾加两个空格
    或直接空一行

3. 文本样式

*斜体文本* 或 _斜体文本_
**粗体文本** 或 __粗体文本__
***粗斜体*** 或 ___粗斜体___
~~删除线文本~~

4. 列表

无序列表

- 项目1
- 项目2
  - 子项目1
  - 子项目2
* 也可以使用星号

有序列表

1. 第一项
2. 第二项
   1. 子项1
   2. 子项2

5. 链接和图片

[链接文字](URL "可选标题")

![图片描述](图片URL "可选标题")

6. 引用

> 引用内容
> 
> 多行引用
>> 嵌套引用

7. 代码

行内代码

使用 `code` 表示行内代码

代码块

```语言名称
代码内容
```

示例:

def hello():
    print("Hello, World!")

8. 水平线

---
***
___

9. 转义字符

\* 显示星号而不是斜体
\# 显示井号而不是标题

进阶语法

1. 表格

| 表头1 | 表头2 | 表头3 |
|-------|-------|-------|
| 单元格 | 单元格 | 单元格 |
| 左对齐 | 居中对齐 | 右对齐 |

对齐方式:

| 左对齐 | 居中对齐 | 右对齐 |
|:------|:------:|------:|
| 内容   | 内容    | 内容   |

2. 任务列表

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

3. 脚注

这里有一个脚注[^1]

[^1]: 这是脚注内容

扩展语法(部分平台支持)

1. 定义列表

术语1
: 定义1

术语2
: 定义2

2. 缩写

*[HTML]: HyperText Markup Language
*[CSS]: Cascading Style Sheets

现在可以使用 HTML 和 CSS 缩写

3. 高亮文本

==高亮文本==

4. 下标和上标

H~2~O
x^2^

5. 数学公式

```math
E = mc^2
```

行内公式:$E = mc^2$

6. 流程图、时序图等

```mermaid
graph TD
    A[开始] --> B{判断}
    B -->|是| C[执行]
    B -->|否| D[结束]

---

## 使用技巧

### 1. 最佳实践
- 保持简洁,避免过度格式化
- 标题层级要合理,不要跳级
- 列表缩进使用2个空格
- 长文档使用目录

### 2. 编辑器推荐
- **VS Code** + Markdown扩展
- **Typora**(所见即所得)
- **Obsidian**(知识管理)
- **在线编辑器**:StackEdit、Dillinger

### 3. 常用快捷键
- **加粗**:`Ctrl/Cmd + B`
- **斜体**:`Ctrl/Cmd + I`
- **插入链接**:`Ctrl/Cmd + K`
- **插入图片**:`Ctrl/Cmd + Shift + I`

### 4. 文档结构示例
```markdown
# 文档标题

## 概述
简要介绍...

## 功能特性
- 功能1
- 功能2

## 使用说明
### 安装
步骤说明...

### 配置
配置项说明...

## 常见问题
> Q: 问题描述?
> A: 解决方案

## 参考链接
- [官方文档](URL)

兼容性说明

不同平台(GitHub、GitLab、Notion、语雀等)对Markdown的支持略有差异,建议使用时查看具体平台的文档。


提示:Markdown的核心是让内容清晰易读,不必追求复杂的排版效果。掌握了这些基本语法,你就能应对90%的文档编写需求了!