Markdown使用指南及常用语法

Markdown¹

·简单介绍

• Markdown是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，它可以使普通文本内容具有一定的格式。

·使用指南

一、标题（HEADERS）

• Markdown支持两种样式的标题：Setext和atx。
• Setext样式的标题使用“=”（对于第一级标题）和“-”（对于第二级标题）“加下划线”。

  • 示例

    This is an H1
    ==
    This is an H2
    --
    

  • 效果

    This is an H1

    This is an H2

  • 注：任意数量的“=”或者“-”，都可以。

• Atx样式的标题在行的开头使用1-6个“#”，对应于标题级别1-6。
  • 示例

    # This is an H1
    ## This is an H2
    #### This is an H4
    ###### This is an H6
    

  • 效果：

    This is an H1

    This is an H2

    This is an H4

    This is an H6

• 若关闭atx，可以使用：

  # This is an H1 #
  ## This is an H2 ##
  #### This is an H4 ####
  

---

二、字体（Font）

• 加粗
  在要加粗的文本前后分别加两个*符号。
• 斜体
  在要倾斜的文本前后分别加一个*符号。
• 斜体加粗
  在要倾斜加粗的文本前后分别加三个*符号。
• 删除线
  在要加删除线的文本前后分别加两个~符号。
• 标记
  在要加标记的文本前后分别加两个=符号。
• 上标
  在要上标文本的前后分别加一个^符号
• 下标
  在要上标文本的前后分别加一个~符号
• 示例

**加粗文本**
*斜体文本*
***斜体加粗文本***
~~删除线文本~~
==标记文本==

• 效果
  加粗文本
  斜体文本
  斜体加粗文本
  删除线文本
  标记文本

---

三、引用

• 在引用的文本前加>即可。引用也可以嵌套，可以加一个、两个、三个……

• 示例

  >引用的文本
  >>引用的文本
  >>>引用的文本
  >>>>引用的文本
  >>>>>>>>>>>>>>>引用的文本
  

• 效果

  引用的文本

  引用的文本

  引用的文本

  引用的文本

  引用的文本

---

四、分割线

• 三个及以上的 - 或者 * 即可。

• 示例

  ---
  ------------
  ***
  ***********
  

• 效果

  ---

  ---

  ---

  ---

---

五、图片

• 语法格式
  ![alt](图片地址 ''title'')

  • alt就是显示在图片下面的文字，相当于对图片内容的解释。
  • title是图片的标题，当鼠标移到图片上时显示的内容。title可加可不加

• 示例

  ![博主头像](https://avatar.csdnimg.cn/6/B/7/2_s_scott.jpg)
  

• 效果
  

---

六、超链接

• 语法格式
  [text](超链接地址 "title")

  • text就是显示在页面的文字。
  • title是链接的标题，当鼠标移到链接文字上时显示的内容。title可加可不加

• 示例

  [博客首页](https://blog.csdn.net/s_scott "S_Scott的博客")
  

• 效果
  博客首页

• Markdown可能不支持新页面打开链接，如果想在新页面打开链接，则要考虑HTML语言中的a标签

  • 示例
    // 语法格式：超链接名
博客首页

  • 效果
    博客首页

---

七、列表

• 无序列表
  • 无序列表用 - + * 任何一个字符就可以，不过符号后面要加空格
  • 示例
    - 列表内容
- 列表内容
+ 列表内容
+ 列表内容
* 列表内容
* 列表内容
  • 效果
    • 列表内容
    • 列表内容
    • 列表内容
    • 列表内容
    • 列表内容
    • 列表内容
• 有序列表
  • 数字加小数点
  • 示例
    1.列表内容
2.列表内容
3.列表内容
  • 效果
    1.列表内容
    2.列表内容
    3.列表内容

八、表格

• 语法

  |表头|表头|表头|
  |-|-|-|
  |内容|内容|内容|
  |内容|内容|内容|
  

  • 第二行用来分割表头和内容
    • 在第二行的某一列的两边加上 : ，则文字居中对齐；
    • 若在右边加上一个 : ，则文字右对齐；
    • 若在左边加上一个 : ，则文字左对齐。

• 示例

  |表头1|表头2|表头3|表头四|
  | :- | :-: | -: |-|
  |左对齐|居中对齐|右对齐|默认|
  |文本11|文本12|文本13|文本14|
  |文本21|文本22|文本23|文本34|
  

• 效果

  表头1	表头2	表头3	表头四
  左对齐	居中对齐	右对齐	默认
  文本11	文本12	文本13	文本14
  文本21	文本22	文本23	文本34

---

九、代码片

• 单行代码

  • 语法
    `代码内容`
    • 单行代码之两边加 ` 符号。
    • 注：这个不是引号，将输入切换成英文之后，按键盘上的Tilde键（一般是ESC键下面那个键）
    • Tilde键的位置如下图所示：
      

• 代码块

  • 语法
    ```代码内容```
    • 单行代码之两边加三个 ` 符号。
  • 注：代码片的示例就不举例了。

---

注：时间有限，以后会出一个更全面的Markdown的语法文档。

• 参考资料

https://www.jianshu.com/p/191d1e21f7ed
https://daringfireball.net/projects/markdown/syntax

---

1. 时间有限，以后会出更全面的Markdown语法文章。 ↩︎