Markdown语法

来源:互联网 发布:柬埔寨网络博客 编辑:程序博客网 时间:2024/06/04 07:35

总是用Markdown来写博客,但是却没有真正掌握它的使用。
下面就对Markdown做一个简单的介绍及应用。

  • Markdown 是一种轻量级标记语言,能将文本换成有效的XHTML(或者HTML)文档,它的目标是实现易读易写,成为一种适用于网络的书写语言。
  • Markdown 语法简洁明了,易于掌握,所以用它来写作是件既效率又舒服的事情。我们所熟知的和一些大型CMS,如Joomla!、Drupal等都能很好的支持Markdown。
  • Markdown 不是想要取代 HTML,甚至也没有要和它相近,它的语法种类很少,只对应 HTML 标记的一小部分。
  • Markdown 的构想不是要使得 HTML 文档更容易书写。在我看来, HTML 已经很容易写了。
  • Markdown 的理念是,能让文档更容易读、写和随意改
  • HTML 是一种发布的格式,Markdown 是一种书写的格式
  • 就这样,Markdown 的格式语法只涵盖纯文本可以涵盖的范围。

Markdown 兼容 HTML
如下图示:

<table>    <tr>        <td>one</td>        <td>two</td>    </tr>    <tr>        <td>three</td>        <td>four</td>    </tr></table>
one two three four



Markdown 简明语法介绍:

标题

Markdown 支持两种标题的语法,类 Setext 和类 atx 形式。
类 Setext 形式是用底线的形式,利用 =(最高阶标题)和 -(第二阶标题),例如:

This is an H1=============This is an H2-------------

类 Atx 形式则是在行首插入 1 到 6 个 # ,对应到标题 1 到 6 阶,例如

# 一级标题## 二级标题### 三级标题#### 四级标题##### 五级标题###### 六级标题

个人觉得第二种要好用一些。

换行

<br>

引用

在每行的最前面加上 >

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.> > Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse> id sem consectetuer libero luctus adipiscing.

也可以只用一个>

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisseid sem consectetuer libero luctus adipiscing.

效果如下:

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.

区块引用可以嵌套(例如:引用内的引用),只要根据层次加上不同数量的>

> This is the first level of quoting.>> > This is nested blockquote.>> Back to the first level.

效果如下:

This is the first level of quoting.

This is nested blockquote.

Back to the first level.

引用的区块内也可以使用其他的 Markdown 语法,包括标题、列表、代码区块等:

> ## 这是一个标题。> > 1.   这是第一行列表项。> 2.   这是第二行列表项。> > 给出一些例子代码:> >     return shell_exec("echo $input | $markdown_script");

效果如下:

这是一个标题。

  1. 这是第一行列表项。
  2. 这是第二行列表项。

给出一些例子代码:

return shell_exec("echo $input | $markdown_script");

列表

无序列表

无序列表使用星号、加号或是减号作为列表标记:

*   Red*   Green*   Blue
  • Red
  • Green
  • Blue
+   Red+   Green+   Blue
  • Red
  • Green
  • Blue
-   Red-   Green-   Blue
  • Red
  • Green
  • Blue

有序列表

有序列表则使用数字接着一个英文句点:

1.  Bird2.  McHale3.  Parish
  1. Bird
  2. McHale
  3. Parish
<ol><li>Bird</li><li>McHale</li><li>Parish</li></ol>
  1. Bird
  2. McHale
  3. Parish

列表项目可以包含多个段落,每个项目下的段落都必须缩进 4 个空格或是 1 个制表符

1.  This is a list item with two paragraphs. Lorem ipsum dolor    sit amet, consectetuer adipiscing elit. Aliquam hendrerit    mi posuere lectus.    Vestibulum enim wisi, viverra nec, fringilla in, laoreet    vitae, risus. Donec sit amet nisl. Aliquam semper ipsum    sit amet velit.2.  Suspendisse id sem consectetuer libero luctus adipiscing.
  1. This is a list item with two paragraphs. Lorem ipsum dolor
    sit amet, consectetuer adipiscing elit. Aliquam hendrerit
    mi posuere lectus.

    Vestibulum enim wisi, viverra nec, fringilla in, laoreet
    vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
    sit amet velit.

  2. Suspendisse id sem consectetuer libero luctus adipiscing.

如果你每行都有缩进,看起来会看好很多,当然,再次地,如果你很懒惰,Markdown 也允许:

*   This is a list item with two paragraphs.    This is the second paragraph in the list item. You'reonly required to indent the first line. Lorem ipsum dolorsit amet, consectetuer adipiscing elit.*   Another item in the same list.
  • This is a list item with two paragraphs.

    This is the second paragraph in the list item. You’re
    only required to indent the first line. Lorem ipsum dolor
    sit amet, consectetuer adipiscing elit.

  • Another item in the same list.

如果要在列表项目内放进引用,那 > 就需要缩进

*   A list item with a blockquote:    > This is a blockquote    > inside a list item.
  • A list item with a blockquote:

    This is a blockquote
    inside a list item.

如果要放代码区块的话,该区块就需要缩进两次,也就是 8 个空格或是 2 个制表符

*   一列表项包含一个列表区块:        <代码写在这>
  • 一列表项包含一个列表区块:

    <代码写在这>

当然,项目列表很可能会不小心产生,像是下面这样的写法:

1986. What a great season.
  1. What a great season.

要避免这样的状况,你可以在句点前面加上反斜杠。

1986\. What a great season.

1986. What a great season.

代码区块

在 Markdown 中建立代码区块很简单,只要简单地缩进 4 个空格或是 1 个制表符就可以:

这是一个普通段落:    这是一个代码区块。

这是一个普通段落:

这是一个代码区块。

分隔线

* * *********- - ----------------------------------------

效果如下:






链接

行内式

要建立一个行内式的链接,只要在方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可,如:

This is [an example](http://example.com/ "这里是Title") inline link.[This link](http://example.net/) has no title attribute.

This is an example inline link.

This link has no title attribute.


如果你是要链接到同样主机的资源,你可以使用相对路径:

See my [About](/about/) page for details.

See my About page for details.

参考式

参考式的链接是在链接文字的括号后面再接上另一个方括号,而在第二个方括号里面要填入用以辨识链接的标记:

This is [an example][id] reference-style link.

This is an example reference-style link.

你也可以选择性地在两个方括号中间加上一个空格:

This is [an example] [id] reference-style link.

This is an example reference-style link.
接着,在文件的任意处,你可以把这个标记的链接内容定义出来:

[id]: http://example.com/  "Optional Title Here"

链接内容定义的形式为:

  • 方括号(前面可以选择性地加上至多三个空格来缩进),里面输入链接文字
  • 接着一个冒号
  • 接着一个以上的空格或制表符
  • 接着链接的网址
  • 选择性地接着 title 内容,可以用单引号、双引号或是括弧包着.

下面这三种链接的定义都是相同:

[foo]: http://example.com/  "Optional Title Here"[foo]: http://example.com/  'Optional Title Here'[foo]: http://example.com/  (Optional Title Here)

foo: http://example.com/ ‘Optional Title Here’
下面是一个参考式链接的范例:

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.

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

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"

I get 10 times more traffic from Google than from
Yahoo or MSN.

强调

Markdown 使用星号*和底线_作为标记强调字词的符号,被*_包围的字词会被转成用<em>标签包围,用两个*_包起来的话,则会被转成 <strong>,例如:

*single asterisks*_single underscores_**double asterisks**__double underscores__

single asterisks

single underscores

double asterisks

double underscores

强调也可以直接插在文字中间:

un*frigging*believable

un*frigging*believable

但是如果你的*_两边都有空白的话,它们就只会被当成普通的符号。
如果要在文字前后直接插入普通的星号或底线,你可以用反斜线:

\*this text is surrounded by literal asterisks\*

*this text is surrounded by literal asterisks*

代码

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

Use the `printf()` function.

Use the printf() function.

图片

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

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

![Alt text](/path/to/img.jpg)![Alt text](/path/to/img.jpg "Optional title")

详细叙述如下:

  • 一个惊叹号 !
  • 接着一个方括号,里面放上图片的替代文字
  • 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上 选择性的 ‘title’ 文字。

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

![Alt text][id]

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

[id]: url/to/image  "Optional title attribute"

自动链接

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

<http://example.com/>

http://example.com/

反斜杠

Markdown 可以利用反斜杠来插入一些在语法中有其它意义的符号,例如:如果你想要用星号加在文字旁边的方式来做出强调效果(但不用 <em> 标签),你可以在星号的前面加上反斜杠:

\*literal asterisks\*

*literal asterisks*

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

\   反斜线`   反引号 *   星号_   底线{}  花括号[]  方括号()  括弧#   井字号 *   加号 *   减号.   英文句点!   惊叹号

Markdown官网:http://daringfireball.net/projects/markdown/
参考资料:http://markdown.tw/
Markdown在线编辑器
* Dillinger:http://dillinger.io/
* Markdown Here:http://markdown-here.com/livedemo.html

详情参见:
https://www.w3cschool.cn/markdownyfsm/