0%

GitHub Flavored Markdown语法介绍

自Markdown语言产生以来,出现了很多dialect(即语言变种),比如“GitHub Flavored Markdown、Multimarkdown、Maruku”等。本文介绍“GitHub Flavored Markdown”。

一、标题

1.1、语法

“(N个'#')(空格)”
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

1.2、效果

二、加粗和斜体

2.1、语法

**加粗**
*斜体*

2.2、效果

加粗
斜体

三、有序列表

3.1、语法

1. 项目1,“(数字)(.)(空格)”,最后有个空行
2. 项目2
3. 项目3
    1. 子项目1,“(至少3个空格)(数字)(.)(空格)”
    2. 子项目2
    3. 子项目3

3.2、效果

  1. 项目1,“(数字)(.)(空格)”,最后有个空行
  2. 项目2
  3. 项目3
    1. 子项目1,“(至少3个空格)(数字)(.)(空格)”
    2. 子项目2
    3. 子项目3

四、无序列表

4.1、语法

- 项目1,“(-)(空格)”,最后有个空行
- 项目2
- 项目3
  - 项目4,“(至少两个空格)(-)(空格)”
  - 项目5
  - 项目6

4.2、效果

  • 项目1,“(-)(空格)”,最后有个空行
  • 项目2
  • 项目3
    • 项目4,“(至少两个空格)(-)(空格)”
    • 项目5
    • 项目6

五、链接图片

5.1、语法

![提示文字](图片地址:可以是网络地址,也可以是本地地址)

5.2、效果

Google Logo

六、链接URL

6.1、语法

[提示文字](http://www.google.com)
或者
URL自动识别:http://www.google.com

6.2、效果

提示文字
或者
URL自动识别:http://www.google.com

七、行内引用

7.1、语法

接下来是引用文字:`引用内容`

7.2、效果

接下来是引用文字:引用内容

八、块级引用

8.1、语法

>这是块级引用第一部分,最后有个空行
>这是块级引用第二部分
>这是块级引用第三部分

8.2、效果

这是块级引用第一部分,最后有个空行
这是块级引用第二部分
这是块级引用第三部分

九、代码引用

9.1、语法

```指定代码使用语言,可选
代码
```

9.2、效果

public class Main {
    public static void main(String[] args) {
        System.out.println("Hello World");
    }
}

十、表格

10.1、语法

|firstCol|secondCol|
|-|-|
|firstContent|secondContent|

10.2、效果

firstCol secondCol
firstContent secondContent

十一、删除线

11.1、语法

~~删除~~

11.2、效果

删除

十二、使用“\”转义元控制字符

12.1、语法

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

12.2、效果

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

十三、其他

“有序列表”,“无序列表”和“块级引用”最后需要一个空行的原因是:以换行符作为结束标记,否则会“惯性”地继续“有序列表”的条目,“无序列表”的条目和“块级引用”的内容。


参考文献: [1]https://guides.github.com/features/mastering-markdown/ [2]https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf [3]https://daringfireball.net/projects/markdown/syntax [4]http://erikge.com/articles/markdownSyntax/
您的支持将鼓励我继续分享!