源本科技 | 码上会

学会使用 Markdown

2026/01/22
52
0

Markdown 是一种轻量级标记语言,由约翰・格鲁伯和亚伦・斯沃茨于 2004 年共同设计,其核心理念是“易读易写”。通过简洁的符号语法,用户无需编写复杂的 HTML 即可创建结构清晰、格式丰富的文档。如今,Markdown 被广泛应用于技术文档、博客写作、项目说明(如 README.md)、笔记整理等场景,深受程序员、科研人员与内容创作者的喜爱。

Slogan:从此爱上写作


为什么选择 Markdown

核心优点

  • 内容与样式分离:专注文字本身,而非排版细节,提升写作效率。

  • 纯文本格式.md 文件兼容所有文本编辑器(如 VS Code、Sublime Text、记事本等),无平台或版本限制。

  • 多格式导出:轻松转换为 HTML、PDF、Word 等格式,便于发布与分享。

  • 高可读性:即使未渲染,源文件也清晰易懂,学习成本极低。

典型应用场景

场景

说明

在线阅读

技术博客、帮助文档(如 GitHub 的 README.md)、知识库文章

轻量编辑

快速撰写简洁文档,避免 Word 等重型工具的复杂样式干扰(不适用于排版密集型内容,如宣传册、学术期刊)

跨平台协作

同一 .md 文件可在任意设备上编辑,并通过 Git 等工具高效版本管理

快速发布

集成 Markdown 的平台(如掘金、知乎、Notion)支持直接粘贴源码发布

适用人群

  • 程序员 & 科研工作者:撰写 API 文档、实验记录、技术博客

  • 学生:整理课堂笔记、撰写课程论文(配合 LaTeX 数学公式)

  • 作家 & 博主:创作文章、书籍草稿

  • 普通用户:日常笔记、待办清单、知识管理


基本语法

通用规范:所有符号后建议加一个空格(如 # 标题- 列表项),以确保最佳兼容性。


标题

使用 1~6 个 # 表示六级标题:

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

提示:合理使用标题层级有助于生成清晰的文档结构。


目录

部分编辑器支持自动生成目录:

[TOC]

注意[TOC] 是扩展语法,GitHub 原生不支持。Typora、Obsidian、VS Code(需插件)等本地工具通常支持。


强调文本

**粗体** 或 __粗体__
*斜体* 或 _斜体_
~~删除线~~
==高亮标记==        <!-- 扩展语法,仅部分编辑器支持 -->
<u>下划线</u>       <!-- 使用 HTML 标签,非标准 Markdown -->

兼容性说明

  • ==...== 在 Obsidian、Typora 中有效,但 GitHub 不支持。

  • <u>...</u> 是 HTML,虽可渲染,但建议慎用以保持纯 Markdown 风格。


列表

有序列表

Markdown 会自动编号,无需手动维护数字:

1. 第一项
1. 第二项
1. 第三项

渲染效果始终为 1、2、3……

无序列表

使用 -*+(推荐统一用 -):

- 一级列表
  - 二级列表
    - 三级列表
- 另一个一级项

任务列表

- [ ] 待办任务
- [x] 已完成任务

GitHub、GitLab、Obsidian 等平台原生支持此功能。

列表嵌套与多段落

在列表项中添加新段落或引用时,需缩进 4 个空格1 个 Tab

1. 主任务
   这是该任务的详细说明段落。
   
   > 这是一条嵌套引用。
   
       // 这是代码块(需缩进 8 空格或 2 Tabs)
       print("Hello, Markdown!")

引用

使用 > 开头,支持嵌套:

> 这是一级引用。
>> 这是二级嵌套引用。
>
> 回到一级引用。

代码

内联代码

用单个反引号包裹:

使用 `printf()` 函数输出内容。

代码块

推荐使用围栏语法

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

优势:

  • 支持语法高亮(指定语言标识符如 pythonjavascript

  • 无需缩进,结构清晰

  • 兼容性优于缩进式代码块(旧式:每行前加 4 空格)


链接与图像

语法高度相似,图像仅多一个 !

[链接文字](https://example.com "可选标题")
![图片描述](/path/to/image.png "可选标题")

图片路径可为本地路径或 URL。若用于 GitHub,建议使用相对路径或图床链接。


表格

使用 | 分隔单元格,- 定义表头分隔线:

| 左对齐 | 居中对齐 | 右对齐 |
|:-------|:--------:|-------:|
| A      |    B     |      C |
| 数据1  |  数据2   |   数据3|

对齐规则

  • :--- → 左对齐

  • :---: → 居中对齐

  • ---: → 右对齐

https://tableconvert.com/zh-cn/markdown-generator

分割线

使用至少 3 个 -*_(可含空格):

---
***
___
- - -

数学公式(扩展语法)

Markdown 本身不支持数学公式,但多数现代编辑器(如 Typora、Obsidian、Jupyter Notebook)通过 KaTeXMathJax 实现 LaTeX 渲染。

行内公式

欧拉恒等式:$e^{i\pi} + 1 = 0$

块级公式(独立居中)

$$
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
$$

$$
2^{10} = 1024
$$

学习资源

https://katex.org/docs/supported.htmlhttps://www.latexlive.com/

注意:GitHub 原生不支持数学公式渲染,需借助插件或转换为图片。


高级技巧

转义字符

若需显示字面量符号(如 *_#),使用反斜杠 \ 转义:

显示星号:\*这不是斜体\*

脚注(部分编辑器支持)

这是一个脚注[^note]。

[^note]: 脚注内容将出现在页面底部。

混用 HTML

Markdown 允许内嵌 HTML,但会降低可移植性:

<details>
<summary>点击展开</summary>
这是隐藏内容。
</details>

在 GitHub、Obsidian 中有效,但不建议过度使用。


学习资源

https://daringfireball.net/projects/markdown/https://www.markdownguide.org/cheat-sheet/