frontend Cheatsheet

Markdown 语法速查表

Markdown 常用语法一页速查:标题、文本格式、链接图片、列表、代码块、表格、引用和扩展语法,覆盖写文档和 README 的高频用法。

把 Markdown 最常用的语法按标题、格式、列表、代码、表格分组整理,写文档时对照查。

markdown文档语法README

标题 Heading

  • # H1
    一级标题,通常用于文章标题
  • ## H2
    二级标题
  • ### H3
    三级标题,最多到 ###### H6
  • 标题\n===
    Setext 风格 H1(下划线 =)
  • 标题\n---
    Setext 风格 H2(下划线 -)

文本格式 Text Style

  • **粗体**
    粗体文本
  • *斜体*
    斜体文本
  • ***粗斜体***
    粗斜体文本
  • ~~删除线~~
    删除线(GFM 扩展)
  • `行内代码`
    行内代码
  • > 引用文本
    块引用
  • > > 嵌套引用
    嵌套引用

列表 List

  • - 无序列表项
    无序列表,也可用 * 或 +
  • 1. 有序列表项
    有序列表,数字自动递增
  • - [ ] 待办
    任务列表未完成(GFM)
  • - [x] 已完成
    任务列表已完成(GFM)
  • - 缩进子项
    缩进 2 空格创建子列表

代码块 Code Block

  • ```python
    围栏代码块,指定语言高亮
  • ```
    代码块结束标记
  • 4空格缩进代码
    缩进式代码块(不推荐,无法指定语言)
  • ```{bash eval=true}
    可执行代码块(Org-mode / R Markdown 语法)

表格与分隔线 Table & HR

  • ---
    水平分隔线(三个以上减号)
  • | 列1 | 列2 |\n| --- | --- |\n| a | b |
    表格,第二行分隔符定义对齐
  • | :--- |
    左对齐列
  • | :---: |
    居中对齐列
  • | ---: |
    右对齐列

容易踩的坑

  • 表格内换行用 <br>,Markdown 表格不支持直接换行。
  • 代码块内反引号冲突时,可用更多的反引号围栏(如 ~~~~ 包裹含 ``` 的内容)。
  • GFM(GitHub Flavored Markdown)支持任务列表、删除线、自动链接和表格,比标准 Markdown 功能多。