Markdown语法

Markdown语法

一、基础语法篇

1. 标题

  1. 在文本下的空行中插入一个或多个 == 可将文本设置为一级标题,例如

    这是一级标题
    ==
    

    显示效果为

    这是一级标题

  2. 在文本下的空行中插入一个或多个 -- 可将文本设置为二级标题,例如

    这是二级标题
    --
    

    显示效果为

    这是二级标题

  3. 在文本所在行首插入1-6个 # 可将文本设置为1-6级标题,例如

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

    显示效果为

    这是一级标题

    这是二级标题

    这是三级标题

    这是四级标题

    这是五级标题
    这是六级标题

2. 段落

  1. 在一个段落后插入一个或多个空行后再开始新的段落,注意不能使用 spacetab代替,例如

    我喜欢使用Markdown。  
    	
    从现在开始我会用它。 
    

    显示效果如下

    我喜欢使用Markdown。

    从现在开始我会用它。

3. 换行

  1. 在一行后插入两个或两个以上 space,然后再插入一个enter 表示一行结束,例如

    这是第一行。
    这是第二行。
    

    显示效果如下

    这是第一行。
    这是第二行。

4. 字体

  1. 在文本前后插入 **__ 可将文本加粗,注意 **__ 和文本之间无空格,例如

    **粗体**
    __粗体__
    

    显示效果为

    粗体
    粗体

  2. 在文本前后插入 *_ 可将文本设置为斜体,注意 *_ 和文本之间无空格,例如

    *斜体*
    _斜体_
    

    显示效果为

    斜体
    斜体

  3. 在文本前后插入 ***___ 可将文本表示为粗斜体,注意 ***___ 和文本之间无空格,例如

    ***粗斜体***
    ___粗斜体___
    

    显示效果为

    粗斜体
    粗斜体

5. 块引用

  1. 在文本所在行首部插入 > 表示引用,例如

    > 引用
    

    显示效果如下

    引用

  2. 在文本所在行首部插入多个 > 表示多级引用,例如

    > 一级引用
    > > 二级引用
    

    显示效果如下

    一级引用

    二级引用

  3. 在段落间的空行中插入 > 表示引用多个段落,例如

    > 引用段落一
    > 
    > 引用段落二
    

    显示效果如下

    引用段落一

    引用段落二

  4. 块引用中可以包含其他Markdown格式元素,但不是所有的格式元素都可以

6. 列表

  1. 无序列表

    1. 在文本所在行首部,插入 -+*space 将文本表示为无序列表项,例如

      - 无序列表
      + 无序列表
      * 无序列表
      

      显示效果如下

      • 无序列表
      • 无序列表
      • 无序列表
    2. 在文本所在行首部,插入4个 space 或一个 tab 缩进表示列表嵌套,例如

      + 无序列表
      	+ 无序列表
      	+ 无序列表
      + 无序列表
      

      显示效果如下

      • 无序列表
        • 无序列表
        • 无序列表
      • 无序列表
  2. 有序列表

    1. 在文本所在行首部,插入 数字 + . + space 将文本表示有序列表项,其中,数字不必按顺序,例如

      2. 有序列表
      5. 有序列表
      3. 有序列表
      

      显示效果如下

      1. 有序列表
      2. 有序列表
      3. 有序列表
    2. 在文本所在行首部,插入4个 space 或一个 tab 缩进表示列表嵌套,例如

      1. 有序列表
      	1. 有序列表
      	2. 有序列表
      2. 有序列表
      

      显示效果如下

      1. 有序列表
        1. 有序列表
        2. 有序列表
      2. 有序列表
  3. 在行首插入4个 space 或一个 tab 缩进后,可嵌套Markdown语法中其他元素,例如

    * 这是第一行。
    * 这是第二行。
      这是一个段落。
    > 这是一个引用。
    * 这是第三行。
    

    显示效果如下

    • 这是第一行。

    • 这是第二行。
      这是一个段落。

    这是一个引用。

    • 这是第三行。

7. 行内代码

  1. 在代码前后插入`表示行内代码,例如

    `行内代码`
    

    显示效果如下

    行内代码

  2. 如果要包含的代码中含有 `,则在代码前后插入连续两个 `,其中` 和代码间插入一个 space,例如

    `` `Markdown` ``
    

    显示效果如下

    `Markdown`

8. 代码块

  1. 在行首插入四个 space 或一个 tab 缩进表示一个代码块,例如

    	public class HelloJava {
    		public static void main(String[] args) {
    		System.out.println("Hello, Java!");
    		}
    	}
    

    显示效果如下

    public class HelloJava {
    	public static void main(String[] args) {
    	System.out.println("Hello, Java!");
    	}
    }
    

9. 水平分割线

  1. 在空行中插入三个或三个以上 *-_表示水平分割线,例如

    ***  
    ----  
    _____  
    

    显示效果如下




10. 链接

  1. [描述](URL) 表示超链接,例如

    [百度](https://www.baidu.com)
    

    显示效果为

    百度

  2. 在URL后插入 space 后可以添加链接标签文本,标签使用 ''""()包含,当用户将指针放在链接上时标签会显示出来,例如

    [百度](https:\\www.baidu.com "百度一下")
    

    显示效果为

    百度

  3. 可在链接前后插入 ** 进行加粗,例如

    **[百度](https://www.baidu.com)**
    

    显示效果为

    百度

11. 引用格式链接

  1. 引用格式链接由两部分构成

    1. 第一部分:在文字之间,形式为 [描述][标记][描述] + space + [标记],其中第二个括号中文本不区分大小写,可以是字母、数字、下划线或标点,例如

      Markdown官方网站[Markdown][1]
      

      显示效果如下

      Markdown官方网站Markdown

    2. 第二部分:可在任意位置,形式为 [描述] + : + 一个或多个space + <URL>[描述] + : + 一个或多个space + <URL> + 标签,其中后一种形式URL可不使用 <> 包含,例如

      [Markdown]: http://markdown.p2hp.com
      

      显示效果如下

12. URL和Email

  1. 使用 <URL>表示URL,点击可进入网址,例如

    <https://www.baidu.com>
    

    显示效果如下

    https://www.baidu.com

  2. 使用 <Email>表示邮箱,例如

    <1234567890@163.com>
    

    显示效果如下

    1234567890@163.com

13. 图片

  1. 使用 ![描述](路径或URL) 表示图片,例如

    ![](https://img-blog.csdnimg.cn/20210308210915768.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0NTM2MzAw,size_16,color_FFFFFF,t_70#pic_center)
    

    显示效果为(图片来源于百度)

    猫

  2. 可以在路径或URL后添加标签(图片来源于百度),例如

    ![](https://img-blog.csdnimg.cn/20210309002443522.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0NTM2MzAw,size_16,color_FFFFFF,t_70#pic_center "边境牧羊犬")
    

    显示效果为

    狗

14. 转义字符

  1. 在要显示的字符前键入 \ 可将Markdown中用作格式文本的字符进行转义,例如

    \\
    \`
    \*
    \_
    \{
    \}
    \[
    \]
    \(
    \)
    \#
    \+
    \-
    \.
    \!
    \|
    

    显示效果如下

    \
    `
    *
    _
    {
    }
    [
    ]
    (
    )
    #
    +
    -
    .
    !
    |

二、 扩展语法篇

1. 表格

  1. 使用三个或三个以上 - 创建列标题、| 将列分隔开可以创建表格,当然可以在列的开头或结尾处也键入 |;另外,表中的单元格宽度不必完全相同,显示时会自动调整宽度,例如

    | 品牌 | 所在地 |
    | --- | --- |
    | 华为 | 深圳 |
    | 小米 | 武汉 |
    | 中兴 | 北京 |
    

    显示效果如下

    品牌 所在地
    华为 深圳
    小米 武汉
    中兴 北京
  2. - 的左侧、右侧和两侧插入 分别表示左对齐、右对齐和居中对齐,例如

    | 型号 | 价格 | 品牌 |
    | :--- | ---: | :---: |
    | huawei P40 | 4499 | 华为 |
    | xiaomi 11 | 3999 | 小米 |
    | redmi K40 | 2799 | 红米 |
    

    显示效果如下

    型号 价格 品牌
    huawei P40 4499 华为
    xiaomi 11 3999 小米
    redmi K40 2799 红米
  3. 在单元格中可以嵌套使用链接、代码(不是代码块)和强调,不能使用标题、引用、列表、水平线、图片和HTML标签

  4. 在表格中使用对应的HTML字符码来显示 |

2. 围栏代码块

  1. 在代码前后一行各插入三个 `~ 来表示中间部分是围栏代码块,这种方式不需要缩进,例如

    ```
    grade = 88
    if grade >= 60 :
    	print("good!")
    else :
    	print("come on!")
    ```
    

    显示效果如下

    grade = 88
    if grade >= 60 :
    	print("good!")
    else :
    	print("come on!")
    
  2. ` 之后、围栏代码块之前指定语言可以高亮显示代码,例如

    ```python
    grade = 88
    if grade >= 60 :
    	print("good!")
    else :
    	print("come on!")
    ```
    

    显示效果如下

    grade = 88
    if grade >= 60 :
    	print("good!")
    else :
    	print("come on!")
    

3. 脚注

  1. 使用 [^标识符] 创建脚注的引用,其中标识符可以是数字或单词,但不能包含空格和 tab ,作用是关联引用和脚注,输出时会按数字顺序排列;使用 [^标识符] + : + 文本 创建脚注,脚注可以放在Markdown元素外的任何位置,例如

    这里讲解脚注[^1]的创建方法。
    [^1]: 脚注是一种在不中断文本的前提下,使读者可以通过点击符号跳转到相应的注释位置阅读注释内容的Markdown元素。
    

    显示效果如下

    这里讲解脚注的创建方法。

4. 定义清单

  1. 在第一行输入要定义的术语,下一行中插入 : + space 后再输入术语的定义表示定义清单,例如

    速度
    : 单位时间内物体移动的距离
    
    加速度
    : 单位时间内速度的变化量
    

    显示效果如下

    速度
    单位时间内物体移动的距离

    加速度
    单位时间内速度的变化量

5. 删除线

  1. 在文本前后插入 ~~ 可为文本添加删除线,例如

    ~~删除线~~
    

    显示效果如下

    删除线

6. 任务清单

  1. - + space 后、表项前插入 [ + space + ] + space 表示任务清单,[] 中输入 x 表示选中该项,例如

    - [x] 上毛概课
    - [ ] 自习
    - [ ] 上R语言课
    - [ ] 自习
    

    显示效果如下

参考资料

  1. [Matt Cone. The Markdown Guild.pdf.](http://markdown.p2hp.com/book/ 2021.03)

  1. 脚注是一种在不中断文本的前提下,使读者可以通过点击符号跳转到相应的注释位置阅读注释内容的Markdown元素。 ↩︎

posted @   timemiser  阅读(60)  评论(0编辑  收藏  举报
相关博文:
阅读排行:
· TypeScript + Deepseek 打造卜卦网站:技术与玄学的结合
· 阿里巴巴 QwQ-32B真的超越了 DeepSeek R-1吗?
· 【译】Visual Studio 中新的强大生产力特性
· 10年+ .NET Coder 心语 ── 封装的思维:从隐藏、稳定开始理解其本质意义
· 【设计模式】告别冗长if-else语句:使用策略模式优化代码结构
点击右上角即可分享
微信分享提示