写在前面
Markdown 是写 README、技术方案、掘金文章最常用的标记语言。语法不多,但记混标题层级、代码块和表格很常见。下面按「能直接粘贴」整理一版速查,并附简历/文档场景示例。
1. 标题
markdown
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
建议正文从二级标题起,一级留给文章标题(多数平台会自动用页面标题)。
2. 段落与强调
markdown
普通段落直接写,空一行分段。
**加粗**
*斜体*
~~删除线~~
`行内代码`
效果:
加粗 · 斜体 · 删除线 · 行内代码
3. 列表
无序:
markdown
- 苹果
- 香蕉
- 子项
有序:
markdown
1. 第一步
2. 第二步
3. 第三步
任务列表(部分平台支持):
markdown
- [x] 已完成
- [ ] 待办
4. 链接与图片
markdown
[掘金](https://juejin.cn)

仓库内相对路径也可:。
5. 引用与分割线
markdown
> 这是一段引用
> 可多行
---
这是一段引用示例。
6. 代码块
行内:const a = 1
围栏代码块(务必写语言,方便高亮):
markdown
```js
function hello(name) {
return `Hello, ${name}`
}
```
js
function hello(name) {
return `Hello, ${name}`
}
7. 表格
markdown
| 语法 | 说明 | 场景 |
| --- | --- | --- |
| `#` | 标题 | 文档结构 |
| `-` | 无序列表 | 要点罗列 |
| \`\`\` | 代码块 | 示例代码 |
| 语法 | 说明 | 场景 |
|---|---|---|
# |
标题 | 文档结构 |
- |
无序列表 | 要点罗列 |
| ``````````` | 代码块 | 示例代码 |
对齐(部分渲染器支持):
markdown
| 左对齐 | 居中 | 右对齐 |
| :--- | :---: | ---: |
| a | b | c |
8. Mermaid 图表(掘金等支持)
markdown
```mermaid
flowchart LR
A[写 Markdown] --> B[提交仓库]
B --> C[渲染预览]
```
flowchart LR
A[写 Markdown] --> B[提交仓库]
B --> C[渲染预览]
9. 简历 / 文档实战片段
markdown
## 工作经历
### 某某科技 · 前端工程师(2022.07 - 至今)
- 负责某某后台的表格与筛选体验,首屏可交互时间下降约 30%
- 维护组件库文档(Markdown + 示例),减少重复答疑
## 项目
**json-quick-copy** --- 粘贴 JSON 生成表格,支持整列复制
技术栈:原生 HTML / CSS / JS
写简历时注意:
- 用二级/三级标题分层,少用纯加粗当标题
- 每一条经历尽量「做了什么 + 结果」
- 链接放到文末或项目名上,避免开篇堆外链
10. 常见坑
| 问题 | 原因 | 处理 |
|--------|-------------|------------------|-----|----|
| 代码不高亮 | 围栏没写语言 | 写成 ```````js```` |
| 表格乱了 | 分隔行缺少 --- | 表头下必须有 ` | --- | ` |
| 列表粘成一段 | 列表前后没空行 | 列表上下各空一行 |
| 图片不显示 | 路径错 / 需登录资源 | 用可公开访问的 URL |
总结
先记四样就够日常写文档:标题、列表、链接、代码块;表格和 Mermaid 用到再查本页即可。把这篇收藏成速查表,比每次搜「markdown 表格怎么写」更省事。