正文

程序员都在用的Markdown语法从标题到表格代码块全场景实战教程新手也能一看就会

/0 浏览量
1003

程序员都在用的Markdown语法从标题到表格代码块全场景实战教程新手也能一看就会

你第一次看到有人打字能直接打出带格式的漂亮文档时，是不是也懵过？”等等，这也没用Word啊，怎么就这么整齐了？”

别急，今天咱们就聊聊这个神器——Markdown。我不会跟你扯什么”Markdown是由John Gruber于2004年创立的”这种废话，咱直接上干货，让你看完就能上手。

先搞清楚，Markdown到底是什么

打个比方，你平时写东西用Word，就像去餐厅点菜，服务员问你”要几分熟、什么调料、摆什么盘”，一顿操作下来你头晕。

Markdown不一样，它就像你自己在家煮泡面——撕开包装，倒热水，三分钟后开吃。简单、直接、没那么多弯弯绕。

它的核心思想就一个：用纯文本符号，表达简单的格式。

不信？你看下面这两行：

# 这是一级标题
## 这是二级标题

渲染出来就是：

这是一级标题

这是二级标题

是不是秒懂？# 后面加个空格，就是标题。就这么简单。

标题：从一级到六级，层级分明不混乱

写长文章最怕什么？结构乱。读者看着看着就懵了。Markdown用 # 的数量来区分标题层级，一共六级：

# 第一层标题（最大，通常用作文章总标题）
## 第二层标题（一级小节）
### 第三层标题（二级小节）
#### 第四层标题
##### 第五层标题
###### 第六层标题（最小，谨慎使用）

实际使用建议： 大多数人用1到3级就够了。你想想，你写个博客或文档，有必要搞到第六级吗？那是写论文才用的密度。

举个例子，我写教程一般这么安排：

# Markdown完全实战指南
## 为什么要学Markdown
### 效率碾压Word
###  everywhere都能用
## 基础语法速成
### 标题和段落
### 强调文字

这样读者一眼就能看清你的文章骨架，对吧？

段落和换行：别小看这两个基础操作

段落

两个换行 = 一个新段落。就这么简单：

这是第一段。

这是第二段。

这是第三段。

渲染效果就是三段分明的文字。别偷懒一个换行就想分段，那样在大多数渲染器里还是一段。

换行

有时候你非要换行但不想分段（比如写歌词或者地址），用两个空格 + 回车：

第一行  
第二行  
第三行

或者直接用 <br> 标签：

第一行<br>
第二行<br>
第三行

两种都行，看你喜欢哪个。

强调文字：加粗和斜体，让重点跳出来

写东西不突出重点，读者就像在茫茫文字海洋里捞针。Markdown给你两种武器：

加粗

用两个星号或两个下划线包住文字：

**这段文字会加粗**
__这段也会加粗__

效果：这段文字会加粗

斜体

用一个星号或一个下划线：

*这段文字是斜体*
_这段也是斜体_

效果：这段文字是斜体

加粗+斜体

两个星号包一个星号，或者反过来：

***这段文字又粗又斜***

效果：这段文字又粗又斜

一个小技巧： 你选中文本按 Ctrl+B 加粗、Ctrl+I 斜体，很多Markdown编辑器会自动给你加上对应的符号。不用死记硬背。

删除线

划掉不想保留的文字，用两个波浪号：

~~这段文字会被划掉~~

效果：这段文字会被划掉

这个在写TODO列表或者标注过时内容时特别好用。

引用：让文字”说话”，层次分明

写文章经常需要引用别人的话，或者标注自己的思考。用 > 符号：

> 这是引用文字，左边会出现一条竖线。

> 引用可以跨越多行。
> 只要每行前面都加上 > 就行。

> 嵌套引用也没问题：
> > 这是嵌套在引用里的引用。

效果：

这是引用文字，左边会出现一条竖线。

引用可以跨越多行。 只要每行前面都加上 > 就行。

嵌套引用也没问题：

这是嵌套在引用里的引用。

引用块非常适合写注释、标注来源，或者在代码讲解时插入说明文字。

列表：有序和无序，选对场景是关键

无序列表

用 -、* 或 + 都可以：

- 苹果
- 香蕉
- 橙子

* 第一个选项
* 第二个选项
* 第三个选项

+ 还可以这样写
+ 效果一样

渲染效果都一样，选一个你顺眼的用就行。我习惯用 -，因为输入最顺手。

有序列表

用数字加点：

1. 第一步：打开编辑器
2. 第二步：输入Markdown符号
3. 第三步：保存为.md文件
4. 第四步：渲染查看效果

效果：

  1. 第一步：打开编辑器
  2. 第二步：输入Markdown符号
  3. 第三步：保存为.md文件
  4. 第四步：渲染查看效果

列表嵌套

列表还能套列表，写步骤说明时特别实用：

1. 准备材料
   - 面粉 200克
   - 鸡蛋 2个
   - 糖 50克
2. 开始制作
   - 搅拌面糊
   - 倒入模具
   - 放入烤箱 180度 25分钟

效果：

  1. 准备材料
    • 面粉 200克
    • 鸡蛋 2个
    • 糖 50克
  2. 开始制作
    • 搅拌面糊
    • 倒入模具
    • 放入烤箱 180度 25分钟

链接和图片：让文档活起来

超链接

格式是 [显示文字](链接地址)：

[访问GitHub](https://github.com)
[访问百度](https://www.baidu.com)

效果：访问GitHub 访问百度

有时候你不想显示网址，但想让读者知道点开后去哪，可以加个”title”：

[访问GitHub](https://github.com "去GitHub看看开源世界")

鼠标悬停时会显示括号里的文字。

图片

和图片类似的语法，只是前面多了个感叹号：

![一只可爱的猫咪](https://example.com/cat.jpg "萌宠来袭")

![]() 这三个符号记得住就行——感叹号告诉浏览器”这是图片”，中括号里是替代文字（图片加载不出来时显示），小括号里是图片地址和可选的标题。

一个实用场景： 你在写技术文档，需要放截图。直接把图片链接贴进去，比Word里插入图片方便多了，尤其是分享给别人的时候，别人点开就能看到，不用传附件。

代码：程序员的生命线，三种写法

写代码的文档，没有代码高亮是不完整的。Markdown给了你三种方式：

行内代码

用反引号 ` 包裹：

在Python中，打印hello world用 `print("hello world")`

效果：在Python中，打印hello world用 print("hello world")

这种适合在段落中穿插提到代码片段，不打断阅读节奏。

代码块

用三个反引号 “` 包裹，还能指定语言：

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

hello()
```

```javascript
function hello() {
    console.log("Hello, World!");
}

hello();
```

```bash
git clone https://github.com/user/repo.git
cd repo
npm install
npm start
```

效果如下：

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

hello()

function hello() {
    console.log("Hello, World!");
}

hello();

git clone https://github.com/user/repo.git
cd repo
npm install
npm start

注意： 三个反引号后面紧跟语言名称，渲染器就会自动给你高亮代码。支持的语言很多，写常见的 Python、JavaScript、Java、C++、Go、Rust、HTML、CSS、SQL、Bash 都没问题。

缩进代码块

如果你不想用反引号（比如代码里本身就有很多反引号），可以用四个空格或一个Tab缩进：

    def hello():
        print("Hello")
    
    hello()

效果：

    def hello():
        print("Hello")
    
    hello()

不过这种方式不会高亮，所以现在大家基本都用反引号方式了。

表格：数据展示，清晰一目了然

表格是Markdown里稍微麻烦一点但也非常实用的功能：

| 姓名   | 年龄 | 职业     | 擅长       |
|--------|------|----------|------------|
| 小明   | 25   | 前端开发 | React      |
| 小红   | 28   | 后端开发 | Python     |
| 小刚   | 30   | 全栈开发 | 什么都干   |
| 小丽   | 22   | 设计师   | Figma      |

效果：

姓名 年龄 职业 擅长
小明 25 前端开发 React
小红 28 后端开发 Python
小刚 30 全栈开发 什么都干
小丽 22 设计师 Figma

对齐方式

默认是左对齐，但你可以控制每一列的对齐方式：

| 左对齐 | 居中   | 右对齐 |
|:-------|:------:|-------:|
| 内容1  | 内容2  | 内容3  |
| 内容4  | 内容5  | 内容6  |

效果：

左对齐 居中 右对齐
内容1 内容2 内容3
内容4 内容5 内容6

看第二行，: 在左边就是左对齐，在两边就是居中，在右边就是右对齐。记住这个规律就行。

表格的应用场景

  • 产品功能对比表
  • API参数说明
  • 价格方案展示
  • 时间线/日程安排
  • 任何需要数据排列的内容

分割线：视觉分隔，让页面不拥挤

两条路之间需要隔离带，文章段落之间也需要。用三个或更多 - 或 *：

---

***

___

效果就是三条横线分隔符，把不同板块隔开，视觉上更舒服。

# 第一部分：基础语法

这里讲标题、段落、强调...

---

# 第二部分：进阶技巧

这里讲表格、代码、链接...

特殊符号和转义：当符号本身需要显示时

有时候你想显示Markdown的语法符号本身，而不是让它产生格式效果。比如在写教程时解释 # 的用法：

用 \ 在符号前面转义：
\# 这不是标题，就是文字 #
\* 这不是斜体，就是文字 *

效果：用 \ 在符号前面转义： # 这不是标题，就是文字 # * 这不是斜体，就是文字 *

常见的需要转义的符号：\ 、 * 、 _ 、 [ 、 ] 、 (、)、 # 、 + 、 - 、 . 、 ! `

实战：写一份完整的技术文档

光说不练假把式。我们来写一份实际的技术文档，把这些语法全用上：

# Python 基础语法速查表

> 本文档适合Python零基础学员，快速掌握核心语法。

---

## 一、变量与数据类型

Python的变量不需要声明类型，赋值即创建：

```python
# 整数
age = 25

# 浮点数
price = 99.9

# 字符串
name = "小明"

# 布尔值
is_student = True

# 列表
fruits = ["苹果", "香蕉", "橙子"]

# 字典
person = {
    "name": "小红",
    "age": 22,
    "hobby": ["阅读", "编程"]
}
```

### 常用数据类型对比

| 类型 | 示例 | 说明 |
|------|------|------|
| int | `42` | 整数 |
| float | `3.14` | 小数 |
| str | `"hello"` | 字符串 |
| bool | `True` | 布尔值 |
| list | `[1, 2, 3]` | 列表 |
| dict | `{"a": 1}` | 字典 |

---

## 二、条件判断

```python
score = 85

if score >= 90:
    print("优秀")
elif score >= 60:
    print("及格")
else:
    print("需要加油")
```

> **注意：** Python用缩进表示代码块，不要用花括号！

---

## 三、循环结构

### for循环

```python
# 遍历列表
fruits = ["苹果", "香蕉", "橙子"]
for fruit in fruits:
    print(f"我喜欢{fruit}")

# 使用range
for i in range(5):
    print(i)  # 输出 0 1 2 3 4
```

### while循环

```python
count = 0
while count < 5:
    print(count)
    count += 1
```

---

## 四、函数定义

```python
def greet(name, greeting="你好"):
    """
    打招呼函数
    :param name: 姓名
    :param greeting: 问候语
    :return: 问候字符串
    """
    return f"{greeting}，{name}！"

# 调用函数
message = greet("小明")
print(message)  # 输出：你好，小明！
```

---

## 五、常用技巧

1. **列表推导式** — 一行代码搞定列表生成
2. **f-string格式化** — Python 3.6+推荐写法
3. **try-except异常处理** — 让程序更健壮
4. **with语句** — 自动管理资源（如文件打开关闭）

### 列表推导式示例

```python
# 普通写法
squares = []
for i in range(10):
    squares.append(i ** 2)

# 列表推导式写法
squares = [i ** 2 for i in range(10)]
```

---

## 六、学习资源

- [Python官方文档](https://docs.python.org/zh-cn/3/)
- [菜鸟教程Python](https://www.runoob.com/python3/)
- 推荐书籍：《Python编程从入门到实践》

---

*最后更新：2024年*

看完了吗？这份文档里用到了：标题、引用、分割线、代码块（带语言标识）、表格（带对齐）、有序列表、无序列表、行内代码、链接、斜体/加粗。一口气全练了一遍。

常见平台怎么使用Markdown

GitHub / GitLab

  • 写 README.md 文件，仓库页面自动渲染
  • Issue和PR的评论区也支持Markdown
  • Gist可以创建带语法高亮的代码片段

笔记软件

  • Typora — 所见即所得，写完直接看效果，新手神器
  • Obsidian — 本地Markdown笔记，插件丰富，知识管理利器
  • Notion — 支持Markdown快捷输入（输入 / 快速插入各种元素）
  • 飞书/钉钉文档 — 内置Markdown支持
  • 语雀 — 阿里出品，Markdown体验不错

博客平台

  • CSDN、掘金、知乎 — 写文章时切换到Markdown模式
  • Hexo / Hugo — 静态博客生成器，用Markdown写文章，一键部署
  • WordPress — 有Markdown插件

即时通讯

  • Discord、Slack、Telegram — 支持基础Markdown格式
  • 微信、QQ不行，别尝试了 😂

新手最容易踩的坑

坑1：标题后面没加空格

#错误写法    这不会变成标题，只是普通文字
#正确写法   加了空格才是标题

# 后面必须有一个空格，这是最常见的错误。

坑2：代码块语言标识写错

```python   正确
```py       错误，不支持
```Pyton    错误，拼写错了

写错语言标识就不会有语法高亮，但代码依然会显示，只是少了颜色区分。

坑3：表格列数对不上

| 列1 | 列2 | 列3 |
|-----|-----|-----|
| a   | b   |     |   ← 这一行只有两列，但表格定义了三列

渲染器通常会补齐或缺失内容，但显示效果会乱。每行列数要和表头一致。

坑4：嵌套列表缩进不对

- 外层第一项
  - 内层第一项    ← 两个空格缩进
    - 再内层      ← 再两个空格
- 外层第二项

缩进用两个空格或一个Tab，保持一致。混着用容易乱。

坑5：图片链接失效

![图片](https://example.com/broken.jpg)

网络图片如果链接失效，渲染器会显示一个破图图标。写重要文档时，最好把图片下载到本地，用相对路径引用：

![图片](./images/photo.jpg)

如何快速上手练习

  1. 下载一个编辑器 — 推荐 Typora（付费但体验最好）或 MarkText（免费开源）
  2. 新建一个 .md 文件 — 后缀必须是 .md
  3. 边写边看效果 — 编辑器会实时渲染，所见即所得
  4. 找一个真实项目练手 — 给开源项目写README、在博客写文章、在笔记软件整理知识
  5. 不要死记硬背 — 遇到不记得的语法，随手查一下，用多了自然就会了

一句话总结

Markdown就是用最简单的符号，表达最常见的格式。标题用 #，加粗用 **，代码用 “，链接用` —— 记住这几个核心，剩下都是锦上添花。

你现在就可以打开任何一个支持Markdown的编辑器，试试把上面教程里的语法敲一遍。五分钟后，你就会发现自己已经会用了。

-- 展开阅读全文 --