Markdown 使用笔记
Markdown是一种语法,其目标是成为一种适用于网络的书写语言。
区块和元素
段落与换行
一个Markdown段落是由一个或多个连续的文本行组成,他的前后要有一个空行,例如一行只包含空格和制表符,则改行会被视为空行。若确实需要换行可以输入<br />
标签。
标题
Markdown支持两种标题的语法,类Setext和atx形式。
Setext形式为底线的形式
1 2 3 4
| This is an H1 ============= This is an H2 -------------
|
Atx形式是在行首添加1-6个#,对应标题1-6阶例如:
1 2 3
| # 这是H1 ## 这是H2 ###### 这是H6
|
区块引用
Markdown 标记区块使用类似Email 中的 >
的引用方式。
1 2 3
| > 这里是一个区块引用, > 自己断行后在每行前面加上 > 符号 > 符号>后面的内容用来表示引用的内容。
|
列表
Markdown支持有序列表和无序列表。
无序列表使用星号、加号或是建好作为标记:
等同于:
也等同于:
有序列表使用数字接着一个英语句号:
1 2 3
| 1. Bird 2. McHale 3. Parish
|
项目列表标记通常放在最左边,但也可以缩进,最多三个空格,项目标记后面则一定要接着至少一个空格或制表符。
1 2 3 4
| * 这是一个段落 这是另一行 * 这是另一个段落 这是另一个段落的另一行
|
如果需要在列表内放进引用,那 > 就需要缩进:
1 2 3
| * 一个区块列表内的引用 > 这里是一个引用 > 在列表中
|
如果需要在列表中防止代码区块,该区块需要缩进两次,即8个空格或两个制表符:
1 2
| * 一列表象包含一个列表区块: <代码写在这里>
|
可能会在行首出现数字-句号-空白,例如1986. In this year.
这时会被误认为有序列表,可以代替为1986\. In this year
分割线
#### 可以在一行中使用三个以上的星号、减号、底线来建立一个分割线,行内不能有其他东西。
1 2 3 4 5
| *** * * * ***** - - - ---------
|
区段元素
链接
Markdown 支持两种形式的链接语法,行内式和参考式,两种形式。不管哪一种,链接文字都是用[ ]
来标记。要建立一个行内式链接,只要在方括号后紧接圆括号,并插入网址链接后面,如果还想加上链接的title文字,只要在网址后面,用双引号吧title文字包起来即可。
1 2
| This is [an enxmple](http://example.com/ "Title") inline link. [This link](http://example.net/ )has no title attribute.
|
参考式链接是在链接文字的括号后面再接上一个括号,在第二个方括号里面添加用以辨识链接的标记:
1 2
| This is [an example][id] reference-style link. This is [an example] [id] reference-style link. //可以在方括号之间添加空格
|
然后在文件的任意地方,将这个标记的链接内容定义出来:
1
| [id]: http:// example.com/ "Optional Title Here"
|
强调
Markdown 使用星号()和底线(_)作为强调字词的符号,被 或_包起来的话,会被转换成````Markdownsingle asteriskssingle underscoresdouble asterisksdouble underscores`
代码
如果要标记一小段行内代码,可以使用(
)`,例如
1
| Use the `printf()` function
|
图片
Markdown 中的图片插入同样支持两种样式:行内式和参考式
1 2 3 4 5 6
| 行内式: ![Alt text](/path/to/img.jpg) ![Alt text](/path/to/img.jpg "Optional title") 参考式: ![Alt text][id] ![id]: url/to/image "Optional title attribute"
|