Markdown是什么
Markdown是一种轻量级标记语言,创立于2004年,由John Gruber和Aaron Swartz共同设计。它使用纯文本格式编写,可以转换为HTML、PDF、Word等多种输出格式。Markdown的核心优势是语法简单、可读性强、生成文档美观,目标是实现"易读、易写、易更改"。
由于是纯文本格式,Markdown文件能够在各种设备和平台上无障碍地打开和编辑,帮助用户更专注于内容本身而非排版样式。
Markdown的常见应用场景
- 项目文档:GitHub上几乎每个项目都有
README.md文件,就是用Markdown编写的 - 技术博客:掘金、CSDN、知乎等平台支持Markdown编辑
- API文档:配合工具自动生成接口文档
- 笔记系统:Notion、Obsidian、Typora等工具以Markdown为核心
- 团队协作:飞书文档、GitLab Wiki等支持Markdown语法
- 教程和电子书籍
- 演示文稿
Markdown核心语法
标题
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
markdown
文本格式
**加粗文本**
*斜体文本*
~~删除线~~
`行内代码`
markdown
列表
- 无序列表项1
- 无序列表项2
1. 有序列表项1
2. 有序列表项2
markdown
链接和图片
[链接文本](https://example.com)

markdown
代码块
```javascript
const greeting = 'Hello World'
console.log(greeting)
markdown
### 表格
```markdown
| 列1 | 列2 | 列3 |
|-----|-----|-----|
| 内容1 | 内容2 | 内容3 |
text
引用
> 这是一段引用文本
> > 引用可以嵌套
markdown
Markdown的扩展用法
Mermaid图表
通过Mermaid语法在Markdown中绘制流程图、时序图等:
```mermaid
graph LR
A[用户请求] --> B{负载均衡}
B --> C[服务器1]
B --> D[服务器2]
markdown
### 数学公式
使用LaTeX语法编写数学公式:
```markdown
行内公式:$E = mc^2$
块级公式:
$$
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
$$
text
任务列表
- [x] 已完成的任务
- [ ] 未完成的任务
markdown
Markdown编辑工具推荐
免费工具
| 工具 | 特点 | 适用场景 |
|---|---|---|
| Typora | 所见即所得,跨平台,支持导出多种格式 | 个人笔记、技术文档 |
| VS Code | 内置预览,配合插件增强 | 开发中编写文档 |
| Obsidian | 知识图谱,双向链接 | 知识管理系统 |
| MarkText | 开源免费,支持多种格式 | 通用文档编写 |
付费工具
| 工具 | 特点 | 适用场景 |
|---|---|---|
| Bear(Mac/iOS) | 界面优美,支持多种导出格式,强大的笔记管理 | Apple生态用户 |
| Ulysses(Mac/iOS) | 专业写作工具,组织和发布功能,iCloud同步 | 长文写作 |
在线工具
- Notion / 映象笔记:在线协作,多平台
- 有道云笔记:国内在线笔记工具
- OneNote:微软出品,更贴近Office风格
写好技术文档的Markdown实践
- 结构清晰:用标题层级组织内容,不超过四级
- 善用表格:对比信息用表格呈现,比纯文字更清晰
- 代码带语言标注:代码块标注语言类型,支持语法高亮
- 关键信息加粗:帮助读者快速定位重点
- 适当使用图表:复杂流程用Mermaid图表达,比文字描述更直观
- 段落分明:空行表示新段落,保持内容的视觉节奏
↑