markdown语法
一、markdown简介
markdown 是一种轻量级标记语言,能将文本换成有效的XHTML(或者HTML)文档,它的目标是实现易读易写,成为一种适用于网络的书写语言。Markdown 语法简洁明了,易于掌握,所以用它来写作是件既效率又舒服的事情。
markdown 的理念是,能让文档更容易读、写和随意改。HTML 是一种发布的格式,Markdown 是一种书写的格式。就这样,Markdown 的格式语法只涵盖纯文本可以涵盖的范围。
二、markdown 标题
markdown 支持两种标题的语法,类 Setext 和 类 Atx 形式。
类 Setext 形式是用底线的形式,利用 =
(最高价标题)和 -
(第二阶标题),例如:
1 | This is an H1 |
任何数量的 =
和 -
都可以有效果。效果如下:
This is an H1
This is an H2
类 Atx 形式则是在行首插入1到6个 #
,对应到标题1到6级标题,例如:
1 | # 一级标题 |
效果如下:
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
三、markdown 段落和换行
一个 markdown 段落是由一个或多个连续的文本行组成,它的前后要有一个以上的空行(空行的定义是显示上看起来像是空的,便会被视为空行。比方说,若某一行只包含空格和制表符,则该行也会被视为空行)。普通段落不该用空格或制表符来缩进。
「由一个或多个连续的文本行组成」这句话其实暗示了 markdown 允许段落内的强迫换行(插入换行符),这个特性和其他大部分的 text-to-HTML 格式不一样(包括 Movable Type 的「Convert Line Breaks」选项),其它的格式会把每个换行符都转成 <br />
标签。
如果你确实想要依赖 markdown 来插入 <br />
标签的话,在插入处先按入两个以上的空格然后回车。
的确,需要多费点事(多加空格)来产生 <br />
,但是简单地「每个换行都转换为 <br />
」的方法在 Markdown 中并不适合, markdown 中 email 式的 区块引用 和多段落的 列表 在使用换行来排版的时候,不但更好用,还更方便阅读。
四、markdown 列表
markdown 支持有序列表和无序列表。
1.无序列表
无序列表用 *
,+
或-
作为列表标记,语法如下:
1 | * red |
等同于:
1 | + red |
也等同于:
1 | - red |
上面三种方式效果如下: red green * blue
2.有序列表
有序列表则使用数字接着一个英文句点:
1 | 1. Bird |
效果如下: 1. Bird 2. McHale 3. Parish
五、markdown 代码区块
和程序相关的写作或是标签语言原始码通常会有已经排版好的代码区块, 通常这些区块我们并不希望它以一般段落文件的方式去排版,而是照原来的样子显示, markdown 会用 <pre>
和 <code>
标签来把代码区块包起来。
要在 Markdown 中建立代码区块很简单,只要简单地缩进 4 个空格或是 1 个制表符就可以, 例如,下面的输入:
1 | 这是一个代码区块 |
在代码区块里面, &
、 <
和 >
会自动转成 HTML 实体,这样的方式让你非常容易使用 markdown 插入范例用的 HTML 原始码,只需要复制贴上,再加上缩进就可以了,剩下的 markdown 都会帮你处理,例如:
1 | <div class="footer"> |
会被转换为:
1 | <pre><code><div class="footer"> |
代码区块中,一般的 markdown 语法不会被转换,像是星号便只是星号,这表示你可以很容易地以 markdown 语法撰写 markdown 语法相关的文件。
六、markdown 分割线
你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:
1 | * * * |
效果如下:
七、markdown 链接
markdown 支持两种形式的链接语法: 行内式和参考式两种形式。
不管是哪一种,链接文字都是用 [方括号] 来标记。
要建立一个行内式的链接,只要在方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可,例如:
1 | This is [an example](http://bing.com/ "Title") inline link. |
效果如下:
This is an example inline link.
This link has no title attribute.
链接内容定义的形式为:
- 方括号(前面可以选择性地加上至多三个空格来缩进),里面输入链接文字
- 接着一个冒号
- 接着一个以上的空格或制表符
- 接着链接的网址
- 选择性地接着 title 内容,可以用单引号、双引号或是括弧包着
下面这三种链接的定义都是相同:
1 | [foo]: http://bing.com/ "Optional Title Here" |
链接网址也可以用尖括号包起来:
1 | [id]: <http://example.com/> "Optional Title Here" |
你也可以把 title 属性放到下一行,也可以加一些缩进,若网址太长的话,这样会比较好看:
1 | [id]: http://example.com/longish/path/to/resource/here |
网址定义只有在产生链接的时候用到,并不会直接出现在文件之中。
链接辨别标签可以有字母、数字、空白和标点符号,但是并不区分大小写,因此下面两个链接是一样的:
1 | [link text][a] |
隐式链接标记功能让你可以省略指定链接标记,这种情形下,链接标记会视为等同于链接文字,要用隐式链接标记只要在链接文字后面加上一个空的方括号,如果你要让 “Google” 链接到 http://google.com,你可以简化成:
1 | [Google][] |
然后定义链接内容:
1 | [Google]: http://google.com/ |
链接的定义可以放在文件中的任何一个地方,我比较偏好直接放在链接出现段落的后面,你也可以把它放在文件最后面,就像是注解一样。
下面是一个参考式链接的范例:
1 | I get 10 times more traffic from [Google] [1] than from |
如果改成用链接名称的方式写:
1 | I get 10 times more traffic from [Google][] than from |
上面两种写法都会产生下面的 HTML。
1 | <p>I get 10 times more traffic from <a href="http://google.com/" rel="external nofollow" target="_blank" |
下面是用行内式写的同样一段内容的 markdown 文件,提供作为比较之用:
1 | I get 10 times more traffic from [Google](http://google.com/ "Google") |
使用 markdown 的参考式链接,可以让文件更像是浏览器最后产生的结果,让你可以把一些标记相关的元数据移到段落文字之外,你就可以增加链接而不让文章的阅读感觉被打断。
八、markdown 强调
markdown 使用星号 *
和底线 _
作为标记强调字词的符号,被 *
或 _
包围的字词会被转成用 <em>
标签包围,用两个 *
或 _
包起来的话,则会被转成 <strong>
,例如:
1 | *single asterisks* |
会转成:
1 | <em>single asterisks</em> |
效果入下:
single asterisks
single underscores
double asterisks
double underscores
你可以随便用你喜欢的样式,唯一的限制是,你用什么符号开启标签,就要用什么符号结束。
强调也可以直接插在文字中间:
1 | un*frigging*believable |
效果如下:
unfriggingbelievable
但是如果你的 *
和 _
两边都有空白的话,它们就只会被当成普通的符号。
如果要在文字前后直接插入普通的星号或底线,你可以用反斜线:
1 | \*this text is surrounded by literal asterisks\* |
效果如下:
this text is surrounded by literal asterisks
九、markdown 代码
如果要标记一小段行内代码,你可以用反引号把它包起来 (
)` ,例如:
1 | Use the `printf()` function. |
十、markdown 图片
markdown 使用一种和链接很相似的语法来标记图片,同样也允许两种样式: 行内式和参考式。
行内式的图片语法看起来像是:
1 | ![Alt text](/path/to/img.jpg) |
详细叙述如下: 一个惊叹号 ! 接着一个方括号,里面放上图片的替代文字 * 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上 选择性的 ‘title’ 文字。
参考式的图片语法则长得像这样:
1 | ![Alt text][id] |
「id」是图片参考的名称,图片参考的定义方式则和连结参考一样:
1 | [id]: url/to/image "Optional title attribute" |
到目前为止, markdown 还没有办法指定图片的宽高,如果你需要的话,你可以使用普通的 <img>
标签。