Markdown语法说明

![markdown-logo.png][markdown-logo]
[markdown-logo]: http://upload-images.jianshu.io/upload_images/947566-5c4a6d0c90dee65d.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240

Markdown 的目标是实现「易读易写」。

行内HTML

  • 不在 Markdown 涵盖范围之内的标签,可以直接在文档里面用 HTML 撰写。
  • 例外:块区元素<div> <table> <pre> <p>,必须在前后加上空白。且不可用空白来缩排。

特殊字符自动转换

例如:在 HTML 文档中,有两个字符需要特殊处理: <&

标题:

Markdown 支持两种标题的语法,[Setext][]和 [atx][] 形式。
[Setext]: http://docutils.sourceforge.net/mirror/setext.html
[atx]: http://www.aaronsw.com/2002/atx/

  • Setext 形式是用底线的形式,利用=(一级标题)和-(二级标题)
  • Atx 形式则是在行首插入 1 到 6 个 #,对应到标题 1 到 6

引言:Blockquotes

  • Markdown 文档中建立一个区块引言,那会看起来像是强迫断行,然后在每行的最前面加上>
  • 允许只在整个段落的第一行最前面加上 >
  • 区块引言可以有级别(例如:引言内的引言),只要根据级别加上不同数量的 >
  • 引言的区块内也可以使用其他的 Markdown 语法,包括标题、列表、程序代码区块等

列表

Markdown 支持有序列表和无序列表

  • 无序列表使用星号*、加号+或是减号-作为列表标记
  • 有序列表则使用数字接着一个英文句点
  • 列表项目可以包含多个段落,每个项目下的段落都必须缩排 4 个空白或是一个 tab

程序代码区块

Markdown 会用 <pre><code>标签来把程序代码区块包起来。

  • 代码块:缩排 4个空白或是 1 个tab 就可以;或直接使用<pre></pre>
  • 高亮:使用 <code>`</code> 或直接使用 <code></code>
  • 用 <code></code>包裹一段代码,并指定一种语言 <pre>\javascript
    $(document).ready(function () {
    alert('hello world');
    });
    ```
    </pre>

支持的语言:actionscript, apache, bash, clojure, cmake, coffeescript, cpp, cs, css, d, delphi, django, erlang, go, haskell, html, http, ini, java, javascript, json, lisp, lua, markdown, matlab, nginx, objectivec, perl, php, python, r, ruby, scala, smalltalk, sql, tex, vbscript, xml

分隔线

在一行中用三个或以上的星号*、减号-、底线_来建立一个分隔线,行内不能有其他东西

链接

Markdown 支持两种形式的链接语法: 「行内」和「参考」两种形式。

  • 建立一个行内形式的链接,只要在方块括号后面马上接着括号并插入网址链接即可。
  • 参考形式的链接使用另外一个方括号接在链接文字的括号后面,而在第二个方括号里面要填入用以辨识链接的标签;接着,在文档的任意处,可以把这个标签的链接内容定义出来。

强调

Markdown 使用星号*和底线_作为标记强调字词的符号。

  • *_包围的字词会被转成用 <em>标签包围。
  • 用两个 *_包起来的话,则会被转成<strong>
  • 如果*_两边都有空白的话,它们就只会被当成普通的符号。
  • 如果要在文字前后直接插入普通的星号或底线,可以用反斜杠

程序代码

如果要标记一小段行内程序代码,可以用反引号<code>`</code>把它包起来

图片

Markdown 使用一种和链接很相似的语法来标记图片,同样也允许两种样式: 「行内」和「参考」。

  • 行内语法:


    Alt text
    Alt text

    Alt text
    Alt text
  • 参考语法:
    ![Alt text][id]

    「id」是图片参考的名称,图片参考的定义方式则和链接参考一样:<pre>[id]:url/to/image "Optional title attribute"</pre>

自动链接

Markdown 支持比较简短的自动链接形式来处理网址和电子邮件信箱,例如:

    <http://example.com/>
    <a href="http://example.com/">http://example.com/</a>

转义字符

Markdown 可以利用<code></code>反斜杠来插入一些在语法中有其它意义的符号。

支持在下面这些符号前面加上反斜杠来帮助插入普通的符号:
<pre>
\ 反斜杠
` 反引号
* 星号
_ 底线
{} 大括号
[] 方括号
() 括号
# 井字号
+ 加号
- 减号
. 英文句点
! 惊叹号
</pre>

参考文档

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,175评论 5 466
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,674评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,151评论 0 328
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,597评论 1 269
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,505评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,969评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,455评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,118评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,227评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,213评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,214评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,928评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,512评论 3 302
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,616评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,848评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,228评论 2 344
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,772评论 2 339

推荐阅读更多精彩内容