Markdown是一种轻量级的标记语言。主要用于写出带有格式的文档。有点相似于HTML语言,可是语法要比HTML语言简单,十分适合书写文档。并且如今大部分博客和文章输入系统都支持这种语法。例若有道笔记和印象笔记等等。在Github上写的REAME.md就是这种语法写出来的说明文档。并且会在Github上直接显示出带有格式的文档结果。html
Markdown 支持两种标题的语法,类 Setext 和类 atx 形式。程序员
类 Setext 形式是用底线的形式,利用 = (最高阶标题)和 - (第二阶标题),例如:ubuntu
This is an H1 ============= This is an H2 -------------
文章的标题格式是最左侧加上#
符号,以后有一个空格,最后右侧写上标题内容。一个井号表明一级标题,两个井号表明二级标题,以此类推,一共有6级。markdown
# 这是 H1 ## 这是 H2 ###### 这是 H6
无序列表使用星号、加号或是减号做为列表标记. 例如:curl
* Red * Green * Blue
或者工具
+ Red + Green + Blue
等同于:学习
- Red - Green - Blue
有序列表是指在列表的每一行前面带有1, 2, 3...数字。这种列表须要在每一行文字前面增长数字+点的方式。例如"1."。而后再接文字。网站
Markdown 标记区块引用是使用相似 email 中用 >
的引用方式。使用大于号在文字前面。google
区块引用能够嵌套(例如:引用内的引用),只要根据层次加上不一样数量的 >
。url
图片是在一个对图片的链接,而不是能嵌入图片。有点像html的img标签的src属性。具体的写法为:
Markdown 支持两种形式的连接语法: 行内式和参考式两种形式。无论是哪种,连接文字都是用 [方括号] 来标记。
格式为: [an example](http://example.com/ "Title")
.
通常简写成[an example](http://example.com/)
参考式的连接是在连接文字的括号后面再接上另外一个方括号,而在第二个方括号里面要填入用以辨识连接的标记: This is [an example][id] reference-style link.
而后在下面的参考位置定义ID的值: [id]: http://example.com/ "Optional Title Here"
连接网址也能够用尖括号包起来。
[id]: <http://example.com/> "Optional Title Here"
隐式连接标记功能让你能够省略指定连接标记,这种情形下,连接标记会视为等同于连接文字,要用隐式连接标记只要在连接文字后面加上一个空的方括号,若是你要让 "Google" 连接到 google.com,你能够简化成:
[Google][]
而后定义连接内容:
[Google]: http://google.com/
连接的定义能够放在文件中的任何一个地方,我比较偏好直接放在连接出现段落的后面,你也能够把它放在文件最后面,就像是注解同样。
使用两个**
和两个下划线围绕文字的左右侧。
使用*
和一个下划线围绕文字的左右侧。
注意: 若是你的 *
和 _
两边都有空白的话,它们就只会被当成普通的符号。
格式以下
| 列表头1 | 列表头2 | 列表头3 | | ------------- |:-------------:| --------:| | 内容1 | 内容2 | 内容3 | | 内容1 | 内容2 | 内容3 |
上面的:
表明对齐的方式。若是冒号两边都有那么表明居中对齐。
代码框是程序员写的文档常常用到的。格式有多种,一种是使用单个反引号(通常在键盘的左侧tab键的上面),把代码包围起来。还有一种使用三个反引号把代码包围起来。若是代码是多行的,建议使用三个反引号比较好,其还能够指定代码的类型,例如是Python代码,或者HTML代码,这样显示的效果能够带有语法高亮。
你能够在一行中用三个以上的星号、减号、底线来创建一个分隔线,行内不能有其余东西。你也能够在星号或是减号中间插入空格。
Markdown语法使用的字符如何与你写的文档中的字符有冲突,那么可使用\
来转义Markdown的字符,变成普通的文字符号。
Markdown提供对以下字符的转义:
\ backslash ` backtick * asterisk _ underscore {} curly braces [] square brackets () parentheses # hash mark + plus sign - minus sign (hyphen) . dot ! exclamation mark
Markdown兼容HTML中一些特殊字符写法。例如版权符号使用@copy
;
参考: