Markdown 语法小结(已发布)

简述

  • Markdown 语法的目标是:成为一种适用于网络的书写语言。 它的语法种类很少,只对应 HTML 标记的一小部分。它能让文档更容易读、写和随意改。HTML 是一种发布的格式,Markdown 是一种书写的格式。
  • Markdown 的格式语法只涵盖纯文本可以涵盖的范围。不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。不需要额外标注这是 HTML 或是 Markdown;只要直接加标签就可以了。要制约的只有一些HTML 区块元素――比如 div、table、p和pre 等标签,必须在前后加上空行与其它内容区隔开,还要求它们的开始标签与结尾标签不能用制表符或空格来缩进。
  • Markdown 语法在 HTML 区块标签间使用无效果,而在 HTML 区段标签间是有效的。

目录

  • 简述
  • 特殊字符自动转换
  • 区块元素
    • 段落和换行
    • 标题
    • 区块引用
    • 列表
    • 代码区块
    • 分割线
  • 区段元素
    • 链接
    • 强调
    • 代码
    • 图片
  • 其他
    • 反斜杠
    • 自动链接

Markdown 语法说明(简体中文)详见:http://wowubuntu.com/markdown/#hr

特殊字符自动转换

  • 在 HTML 文件中,有两个字符需要特殊处理: <和 &。 <符号用于起始签,&符号则用于标记 HTML 实体,如果你只是想要显示这些字符的原型,你必须要使用实体的形式,像是 &lt ;和 &amp ;。而网址中的 &字符也要转换,才能放到链接标签的 href属性里。
  • Markdown 让你可以自然地书写字符,需要转换的由它来处理好了。如果你使用的 &字符是 HTML 字符实体的一部分,它会保留原状,否则它会被转换成&。比如要在文档中插入一个版权符号 ©,可以这样写:©copy ,Markdown 会保留它不动。而若你写:AT&T,Markdown 就会将它转为:AT&amp ;T
  • 类似,如果你是把 <符号作为 HTML 标签的定界符使用,那 Markdown 也不会对它做任何转换,但是如果你写:4 < 5,Markdown 将会把它转换为:4 &lt ; 5
  • 不过需要注意的是,code 范围内,不论是行内还是区块, <和 &两个符号都一定会被转换成 HTML 实体,这项特性让你可以很容易地用 Markdown 写 HTML code 。

区块元素

段落和换行

  一个 Markdown 段落的前后要有一个以上的空行。普通段落  不该用空格或制表符来缩进。
  如果你*确实*想要依赖 Markdown 来插入<br />标签的话,在插入处先按入两个以上的空格然后回车。

标题

  Markdown 支持两种标题的语法,类Setext]和类atx形式。
  类 Setext 形式是用底线的形式,利用=(最高阶标题)和-(第二阶标题),任何数量的=和-都可以
有效果。
  类 Atx 形式则是在行首插入 1 到 6 个#,对应到标题 1 到 6 阶。

区块引用 Blockquotes

  在 Markdown 文件中建立一个区块引用,只需在每行的最前面加上>
  区块引用可以嵌套(例如:引用内的引用),只要根据层次加上不同数量的>
 引用的区块内也可以使用其他的 Markdown 语法,包括标题、列表、代码区块等。

列表

  Markdown 支持有序列表和无序列表。
  无序列表使用星号、加号或是减号作为列表标记。
  有序列表则使用数字接着一个英文句点。
  1.列表项目标记通常是放在最左边,但是其实也可以缩进,最多 3 个空格,项目标记后面则一定要
接着至少一个空格或制表符。
  2.列表项目可以包含多个段落,每个项目下的段落都必须缩进 4 个空格或是 1 个制表符。
  3.如果要在列表项目内放进引用,那>就需要缩进。
  4.如果要放代码区块的话,该区块就需要缩进两次,也就是 8 个空格或是 2 个制表符。
  5. 在行首出现数字-句点-空白,项目列表很可能会不小心产生,像是下面这样的写法:
                                                            1986. What a great season.
     要避免这样的状况,可以在句点前面加上反斜杠。1986\. What a great season.

代码区块

  在 Markdown 中建立代码区块很简单,只要简单地缩进 4 个空格或是 1 个制表符就可以。
   一个代码区块会一直持续到没有缩进的那一行(或是文件结尾)。
   代码区块中,&、<和>会自动转成 HTML 实体,只需要复制贴上,再加上缩进就可以了,
剩下的 Markdown 都会帮你处理。
   代码区块中,一般的 Markdown 语法不会被转换,像是星号便只是星号,这表示你可以很容易地以 
Markdown 语法撰写 Markdown 语法相关的文件。

分隔线

   可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在
星号或是减号中间插入空格。下面每种写法都可以建立分隔线:
                              * * 
                              *********
                              - - -
                              ---------------------------------------

区段元素

链接

  • Markdown 支持两种形式的链接语法: 行内式参考式两种形式。不管是哪一种,链接文字都是用 [方括号] 来标记。
  • 要建立一个行内式的链接,只要在方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可。如果你是要链接到同样主机的资源,你可以使用相对路径。如:

    This is an exampleinline link.
    See my About page for details.
    详见源代码。

  • 参考式的链接是在链接文字的括号后面再接上另一个方括号,而在第二个方括号里面要填入用以辨识链接的标记(链接辨别标签可以有字母、数字、空白和标点符号,但是并区分大小写),也可以选择性地在两个方括号中间加上一个空格,接着,在文件的任意处,你可以把这个标记的链接内容定义出来。如:

    This is an example reference-style link.
    This is an example reference-style link.
    id: http://example.com/ "Optional Title Here"
    链接内容定义的形式为:
    1.方括号(前面可以选择性地加上至多三个空格来缩进)里面输入链接文字
    2.接着一个冒号
    3.接着一个以上的空格或制表符
    4.接着链接的网址
    5.选择性地接着 title 内容,可以用单引号、双引号或是括弧包着
    下面这三种链接的定义都是相同:
    1.[foo]: http://example.com/ "Optional Title Here"
    2.[foo]: http://example.com/ 'Optional Title Here'
    3.[foo]: http://example.com/ (Optional Title Here)

链接网址也可以用尖括号包起来,如:

也可以把 title 属性放到下一行,也可以加一些缩进,若网址太长的话,这样会比较好看:

隐式链接标记功能让你可以省略指定链接标记,这种情形下,链接标记会视为等同于链接文字,要用隐式链接标记只要在链接文字后面加上一个空的方括号,如果你要让 "Google" 链接到 google.com,你可以简化成:

Google

然后定义链接内容:

下面是一个参考式链接的范例:

I get 10 times more traffic from [Google] [1] than from[Yahoo] [2] or [MSN] [3].
[1]: http://google.com/ "Google"
[2]: http://search.yahoo.com/ "Yahoo Search"
[3]: http://search.msn.com/ "MSN Search"

如果改成用链接名称的方式写:

I get 10 times more traffic from Google than from[Yahoo][] or [MSN][].
google: http://google.com/ "Google"
[yahoo]: http://search.yahoo.com/ "Yahoo Search"
[msn]: http://search.msn.com/ "MSN Search"

强调

  • Markdown 使用星号(*)和底线(_)作为标记强调字词的符号,被\ *或 _包围的字词会被转成用 < em >标签包围,用两个\ *或_包起来的话,则会被转成 < strong > 。
  • 但是如果你的 *和 _ 两边都有空白的话,它们就只会被当成普通的符号。
  • 如果要在文字前后直接插入普通的星号或底线,你可以用反斜线:

    \ *this text is surrounded by literal asterisks\ *

代码

  • 如果要标记一小段行内代码,你可以用反引号把它包起来(`),例如:

    Use the printf() function.

    如果要在代码区段内插入反引号,你可以用多个反引号来开启和结束代码区段:

    There is a literal backtick (`) here.

代码区段的起始和结束端都可以放入一个空白,起始端后面一个,结束端前面一个,这样你就可以在区段的一开始就插入反引号:

A single backtick in a code span: `
A backtick-delimited string in a code span: `foo`

在代码区段内,&和尖括号会被自动地转成 HTML 实体。

is the decimal-encoded equivalent of .
Please don't use any <blink> tags.

图片

  • Markdown 允许两种样式来标记图片:行内式参考式

  • 行内式的图片语法看起来像是:

    a cat
    a cat

    a dog
    a dog

    详细叙述如下:
    1.一个惊叹号 !
    2.接着一个方括号,里面放上图片的替代文字
    3.接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上 选择性的 'title' 文字。

  • 参考式的图片语法则长得像这样:

    Alt text
    Alt text

「id」是图片参考的名称,图片参考的定义方式则和连结参考一样:

到目前为止, Markdown 还没有办法指定图片的宽高,如果你需要的话,你可以使用普通的 < img >标签。

其他

自动链接

  • Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱,只要是用尖括号包起来, Markdown 就会自动把它转成链接。

反斜杠

  • Markdown 可以利用反斜杠来插入一些在语法中有其它意义的符号。
    Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

    \ 反斜线

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

推荐阅读更多精彩内容