Sullise
最后修改:

Markdown 常用语法

TIP

所有语法符号均为半角符号


一、标题与文本样式

  1. 标题:使用 # 的数量表示 1 到 6 级标题 。

    • 语法示例:

      markdown
      # 一级标题(H1)
      
      ## 二级标题(H2)
      
      ### 三级标题(H3)
      
  2. 文本样式:

    • 语法示例:
说明语法渲染效果
左右各一个星号包裹文本*斜体* 或 _斜体_斜体
左右各两个星号包裹文本**粗体** 或 __粗体__粗体
左右各三个星号包裹文本***粗斜体*** 或 ___粗斜体___粗斜体
左右各两个波浪线包裹文本~~删除线~~删除线

二、列表、复选框与嵌套缩进

  1. 无序列表:使用 - 或 * 或 + 加空格

    • 语法示例:

      markdown
      - 项目一
      - 项目二
      
  2. 有序列表:使用 数字 + 句点 + 空格 或 数字 + 右括号 + 空格

    • 语法示例:

      markdown
      1. 第一步
      2. 第二步
      
      3) 第三步
      
  3. 复选框(任务列表):使用 - [ ] 表示未完成, - [x] 表示已完成(原方括号中的空格换为字母 x,大小写均可)

    • 语法示例:

      markdown
      - [x] 活着
      - [ ] 死了
      
    • 渲染效果:

      • 活着
      • 死了
  4. 松散列表与紧凑列表

    • 列表项之间加空行为松散列表,渲染效果:

      • 项目一

      • 项目二

      • 项目三

    • 列表项之间不加空行为紧凑列表,渲染效果:

      • 项目 A
      • 项目 B
      • 项目 C
  1. Markdown 的嵌套缩进:通过缩进对齐到父级列表项的"内容列",使后续内容被识别为该列表项的延续,而非独立的新块级元素。"内容列"指的是列表标记符后、第一个非空格字符所在的列位置。例如:

    markdown
    - 列表项 1
    ^^^
    |||
    ||+- 内容列
    |+-- 空格
    +--- 列表标记符占据的位置
    
    1. 列表项 2
    ^^^^
    ||||
    |||+- 内容列
    ||+-- 空格
    |+--- 点号
    +---- 数字
    
    • 列表下可以嵌套列表、段落、围栏代码块、引用块和复选框等,有序列表、无序列表、复选框可以互相嵌套,语法示例:

      markdown
      - 列表项 1
        1. 子列表 1(缩进 2 个空格)
           - [ ] 孙复选框 1(缩进 2 + 3 = 5 个空格)
      
      2. 列表项 2
      
         子段落 1(缩进 3 个空格)
      
         ```txt
         嵌套围栏代码块时,开启和关闭标记(```)及代码内容每行本身都需要进行对应的缩进
         (缩进 3 个空格)
         ```
      
    • 缩进 ≥ 内容列 的内容都被视为该列表项的延续。故而多缩进无害,少缩进一定出错。实际书写时,为兼顾便捷与整齐,可统一使用 4 空格为一缩进 。

三、引用块和提示框(GitHub Alerts/ Callouts)

  1. 引用块:使用 > ,并可用连用多个 > 进行嵌套引用。引用块中也能嵌套其它块级元素(如列表、标题等)

    • 语法示例:

      markdown
      > 单层引用
      >
      > > 嵌套二级引用
      > >
      > > > 嵌套三级引用
      
    • 渲染效果:

      单层引用

      嵌套二级引用

      嵌套三级引用

  2. 提示框(标准用法):

    • GitHub 官方定义的五种标准类型,声明行后需留空(不支持自定义标题), 注意: 多行内容,每一行前都要加上 > 符号
      1. > [!NOTE]
      2. > [!TIP]
      3. > [!IMPORTANT]
      4. > [!WARNING]
      5. > [!CAUTION]
    • 渲染效果:

NOTE

TIP

IMPORTANT

WARNING

CAUTION

  1. 提示框在 Obsidian 等软件中的拓展用法:4. 自定义标题: > [!TIP] 自定义的标题文字 5. 默认折叠/展开: > [!TIP]- 表示默认折叠, > [!TIP]+ 表示默认展开6. 更多类型: 如 [!EXAMPLE] , [!BUG] , [!SUCCESS] , [!FAQ] 等7. 对类型声明 [!TYPE] 中字母的大小写不敏感

四、代码块

  1. 行内代码块:使用反引号 ` 包裹代码

  2. 围栏代码块:代码段上下用三个反引号包裹,并可在首行反引号后紧跟语言名称声明(需小写)

    • 语法示例:

      markdown
      ```c
      井include《studio。h》
      int mian(){
      printf("Hello Word");
      return O;
      }
      ```
      
    • 渲染效果:

      c
      井include《studio。h》
      int mian(){
      printf("Hello Word");
      return O;
      }
      
  3. 代码块的嵌套:外层代码块反引号的数量,必须多于内层代码块反引号的数量。嵌套代码块也遵循 缩进对齐规则

  4. 行首出现 4 个空格时,解析器会识别为”缩进式代码块“

五、表格

Markdown 表格由 表头 , 分隔行 , 数据行 组成,使用管道符 | 区分列。

分隔行 - 的数量要求至少一个

通过在分隔行(第二行)的 - 两侧添加冒号 : ,可以控制对应列的文本对齐方式:

  • :--- 或 --- :左对齐(默认)

  • :---: :居中对齐

  • ---: :右对齐

  • 语法示例:

    markdown
    | 键 A | 键 B | 键 C |
    | ---- | :--: | ---: |
    | 值 1 | 值 2 | 值 3 |
    
  • 渲染效果:

键 A键 B键 C
值 1值 2值 3

六、链接与媒体

  1. 行内式链接: [链接说明文本](URL "可选标题")

  2. 插入图片: ![图片说明文本](图片路径或URL "可选标题")

七、空格、空行规则

为了让编辑器能够正常解析渲染 Markdown 语法,需遵循以下规则:

1. 硬性语法规范

a. 必须加空格

  1. 标题符号 # 与标题文字之间必须保留至少一个空格。
  2. 列表标记( - 、 * 、 + 、 1. )后必须加一个空格。
  3. 复选框 / 任务列表 - [ ] 待办 中: - 后有一个空格, [ 与 ] 之间有一个空格或是英文字母 x , ] 后有一个空格。
  4. 同一段落手动强制换行时,段尾必须加两个以上空格再回车换行,或在段尾敲一个 \。

b. 绝不能加空格

  1. 斜体、粗体、粗斜体、删除线内侧首尾不能有空格
    • 正确: **加粗**
    • 错误: ** 加粗 **
  2. 围栏代码块语言标识符与反引号之间不能有空格
    • 正确: ```python
    • 错误: ``` python

c. 必须加空行

  1. 段落与段落之间必须加空行。
  2. 不同的块级元素之间必须加空行,如标题、分割线、围栏代码块和引用块上下必须留出空行。

2. 软性推荐规范

  1. 引用块 > 后推荐加空格。
  2. 行内 Markdown 语法外侧左右建议加空格,如:
    • 推荐: 这是 **粗体** 文字
    • 不推荐: 这是**粗体**文字

TIP

Markdown 远不止这些……更高级的内容就交给 AI 吧。

留言暂时关闭,稍候恢复

Markdown 常用语法 | Sullise