返回首页
Markdown 写作指南

Markdown 是一种轻量级标记语言,让你专注于内容而非格式

基础语法

标题

Markdown 语法:

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

显示效果:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

文本样式

Markdown 语法:

**粗体文本**
*斜体文本*
***粗斜体文本***
~~删除线~~
`行内代码`
> 引用文本

显示效果:

粗体文本

斜体文本

粗斜体文本

删除线

行内代码

引用文本

列表

无序列表:

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

有序列表:

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

显示效果:

  • 项目 1
  • 项目 2
    • 子项目 2.1
    • 子项目 2.2
  • 项目 3
  1. 第一项
  2. 第二项
  3. 第三项

链接和图片

链接:

[链接文字](https://example.com)
[带标题的链接](https://example.com "鼠标悬停显示")

图片:

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

代码块

行内代码

使用 `console.log()` 输出日志

显示效果:使用 console.log() 输出日志

代码块(支持语法高亮)

使用三个反引号包裹代码,并指定语言:

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

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

```bash
#!/bin/bash
echo "Hello, World!"
```

支持的语言

javascripttypescriptpythonjavagorustbashsqlhtmlcssjsonyamlmarkdowndockernginxphp

表格

Markdown 语法:

| 列1 | 列2 | 列3 |
|------|------|------|
| 内容1 | 内容2 | 内容3 |
| 内容4 | 内容5 | 内容6 |

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

显示效果:

列1列2列3
内容1内容2内容3
内容4内容5内容6

高级技巧

任务列表

- [x] 已完成任务
- [ ] 未完成任务
- [ ] 待办事项
  • ☑ 已完成任务
  • ☐ 未完成任务
  • ☐ 待办事项

分隔线

---
或
***
或
___

转义字符

使用反斜杠 \ 转义特殊字符:

\*不是斜体\*
\[不是链接\]

脚注

这是一个脚注[^1]的示例。

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

写作最佳实践

1.

合理使用标题层级

保持标题层级的逻辑性,不要跳级使用(如从 H2 直接跳到 H4)

2.

代码块指定语言

始终为代码块指定语言,以获得正确的语法高亮

3.

适当使用列表

使用列表整理要点,提高可读性

4.

添加图片说明

为图片添加有意义的描述文字,便于理解和 SEO

5.

保持空行

在不同元素之间保留空行,提高源码可读性

6.

使用实时预览

编辑器提供实时预览功能,随时查看渲染效果

常见问题

Q: 如何在文本中显示反引号?

A: 使用双反引号包裹:``代码中的`反引号``

Q: 如何在列表中添加多个段落?

A: 在段落前添加 4 个空格或 1 个制表符进行缩进

Q: 图片太大怎么办?

A: 上传封面图片时会自动裁剪为 16:9 比例。文章中的图片建议使用图床,并控制尺寸

📖 相关资源