Markdown语法简要

什么是Markdown语法?

Markdown 是一种轻量级标记语言,目标是实现「易读易写」。它的语法非常简单,只相当于HTML标签的一个非常非常小的子集。让(在网上)读文章、写文章、修改文章更容易。
你可以直接用HTML,唯一的限制是那些块级HTML元素 如<div>,<table>, <pre>, <p>等等 必须使用空行与相邻内容分开,并且块元素的开始和结束标签之前不要留有空格或TAB。

标题

Markdown 支持两种风格的标题,Setext 和

Setext-风格的

一级标题下面一行使用等号符号,二级标题下面使用连字符符号,例如:

这是一个一级标题
=============

这是一个二级标题
-------------
至少有一个=和-就能正常工作。

Atx-风格的标题

在每行的开头使用1-6个井号字符,分别对应标题级别1-6。例如:

# 这是一级标题

## 这是二级标题

###### 这是六级标题

如果愿意, 你也可以 “结束” atx-风格的标题。结束用的井号个数随便,不必与起始井号数量相同 (起始井号的数量决定标题级别):

# 这是一级标题 #

## 这是二级标题 ##

### 这是三级标题 ######

引用块

Markdown使用Email风格的 > 字符引用块。如果你熟悉Email中的引用块,你就知道在Markdown中如何使用引用块。如果每一行你都使用硬换行并在行首放一个>符号,看上去会很美观:

> 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. Suspendisse
id sem consectetuer libero luctus adipiscing.
(如果觉得每行写一个>太累,)Markdown允许你偷懒,你只需在硬换行段落的第一行之前放一个>号:

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.
引用块中可包含其它Markdown元素,如标题、列表和代码块:

This is a header.

  1. This is the first list item.
  2. This is the second list item.

Here’s some example code:

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

是个象样的文本编辑器都能实现Email风格的引用。比如在BBEdit里,你就可以选中一些文字之后从Text菜单里选择引用级别。

代码块

我们经常在写有关编程或标记语言源代码时用到预格式化的代码块。不像格式化普通段落,代码块中的行会按字面进行解释。Markdown对代码块同时使用<pre> 和 <code>标签包裹:

在Markdown中要生成一个代码块,只需要在代码块内容的每一行缩进至少四个空格或者一个TAB
比如:

This is a normal paragraph:

This is a code block.

Markdown会生成:

<p>This is a normal paragraph:</p>
<pre><code>This is a code block.
</code></pre>

Markdown会从生成的代码块中删除一级缩进 – 4个空格或者1个TAB。看下面这个例子:

Here is an example of AppleScript:

    tell application "Foo"
        beep
    end tell

会得到:

<p>Here is an example of AppleScript:</p>

<pre><code>tell application "Foo"
    beep
end tell
</code></pre>

代码块在遇到没有缩进的一行,或者文件末尾时自动结束。
在代码块中,&符号和<、>会自动转换成HTML实体(即按照HTML格式去解析这些符号的具体含义,而不会按照MarkDown语法来解析)。因此在Markdown中包含HTML源代码只是小菜一碟--粘贴进去,缩进一下。剩下的脏活累活Markdown自会处理。看下面这个例子:

<div class="sample_footer">
    &copy; 2004 Foo Corporation
</div>

Markdown会生成:
© 2004 Foo Corporation

Markdown不会解析代码块中的Markdown标记。如代码块中的星号就是星号,失去了它原来的Markdown含义。这意味着你能够使用Markdown编写Markdown自己的语法教程。(就象本文章一样)。

列表

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

无序列表可使用*、+和-(等价的,你可以随便用)作为列表标记:
*   Red
*   Green
*   Blue
有序列表则使用数字加英文句点:
1.  Bird
2.  McHale
3.  Parish

有一点需要注意,你在列表中输入的标记数字并不会反映到Markdown输出的HTML之中。
上面这个列表Markdown会输出为:

<ol>
<li>Bird</li>
<li>McHale</li>
<li>Parish</li>
</ol>

即使你写成下面这样:

1.  Bird
1.  McHale
1.  Parish

甚至这样:

3. Bird
1. McHale
8. Parish

都会得到一模一样(但正确的)输出。如果你打算偷懒,记住列表的第一行使用数字 1。以后Markdown或许会支持有序列表从任意数字开始。
列表标记通常从左边界开始,至多可以有三个空格的缩进。列表标记之后至少要跟一个空格或TAB。

为了让列表看起来美观,你可以使用TAB缩进列表项内容,使其整齐:

*   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.

不过如果你很懒,下面这样也行:

*   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.

如果列表项之间用空行分隔,Markdown就会在HTML输出中使用

标签包裹列表项。比如:

*   Bird
*   Magic

生成的HTML如下:


  • Bird
  • Magic

而这个:

    *   Bird

    *   Magic

生成的HTML是这样:


  • Bird

  • Magic

列表项有可能由多个段落组成,列表项的每个后续段落必须缩进至少4个空格或者一个TAB:

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'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.

要在列表项中使用代码块,代码块需要缩进两次 – 8个空格或者两个TAB:

  • A list item with a code block:

    <code goes here>
    

有时候不小心会触发一个有序列表,比方在写类似下面这样的东西时:

1986. What a great season.

换言之, 以数字+句点+空格 序列起始的行会触发有序列表。为避免此情况,要对句点符号进行转义:

1986\. What a great season.

水平线

如果在一行里只放三个或更多个连字符,或星号或下划线,你就会得到一个水平线标记(<hr/>)。下面每一行都会得到一个水平线:

* * *

***

*****

- - -

---------------------------------------

行内元素

链接

Markdown 支持两种风格的链接: 行内链接 和 引用链接.

两种风格的链接,链接文本都放在中括号之内[square brackets]

要生成一个行内链接,在链接文本之后紧跟用一对小括号。小括号里放链接地址和可选的的链接title。

行内风格连接

如果提供链接title的话,链接title要用引号包起来。例如:
这是一个[an example](http://example.com/ "Title") 行内链接。
[这个链接](http://example.net/)没有title属性。

Markdown会生成:

<p>This is <a href="http://example.com/" title="Title">
an example</a> inline link.</p>

<p><a href="http://example.net/">This link</a> has no
title attribute.</p>

如果你打算引用一个本地资源或者同一站点的资源,可以使用相对路径:
如果想进一步了解我,请参阅我的[关于我](/about/)页。

引用风格的链接

在链接文本之后紧跟又一对中括号。这对中括号里放的是该链接的标识符(可以理解为别名):
这是一个引用型链接 [示例][id]
如果你嫌弃两对中括号过于亲密,Markdown允许你在两对中括号之间放一个空格:
这是一个引用型链接 [示例] [id]

然后,我们可以在文档的任意位置,像下面这样定义链接标识与链接的对应关系(一行一个链接):

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

即:

中括号内放链接标识符(行前可选缩进,至多不超过三个空格);
之后紧跟一个冒号;
再后面是一个或多个空格(TAB也行);
接下来是链接URL;
最后面是可选的用双引号或单引号或小括号括起来的链接title。
下面三种链接定义方式是等价的:

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

注意: Markdown.pl 1.0.1 版本有一个已知的bug,用单引号作为链接title的定界符会出问题。

至于链接URL,还支持使用一对可选的尖括号包裹起来:

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

你也可以将链接的title属性放在下一行并使用额外的空格或TAB填充,这样较长的URL会比较美观:

    [id]: http://example.com/longish/path/to/resource/here
    "Optional Title Here"

链妆定义仅供Markdown解析器使用。最终输出的HTML当中不会包含链接定义。

链接标识符可以由字母、数字、空格和标点符号组成--不区分大小写。下面这两个链接:

[link text][a]
[link text][A]

是等价的。

隐式链接标识 允许我们省略链接标识,这时链接文本本身就是链接标识。在链接文本之后加一对空的中括号--例如,使用”Google”文本链接到google.com站点,可以这样写:

Google
然后这样定义它的链接:

链接名字有可能包含空格,不过没问题,这种情况照样正常工作:

Visit Daring Fireball for more information.
然后这样定义这个链接:

链接定义可放于Markdown文档的任意位置。我建议把它们就近放到最先使用它的段落之后。不过如果你更喜欢放到文档末尾,当成某种形式的尾注,随你的便。

下面是一些引用链接的例子:

I get 10 times more traffic from Google [11] than from
Yahoo [12] or MSN [13].

换成隐式链接标识,也可以这么写:

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

上面两种写法最终得到HTML输出是一样的:

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

作为比较,下面这个段落使用Markdown的行内链接风格编写:

I get 10 times more traffic from Google
than from Yahoo or
MSN.
引用型链接的亮点并不在于它更容易书写,而在于引用型链接让你的文档可读性更好。看看上面的例子:使用引用型链接,段落本身仅81个字符;而使用行内链接的例子,是176个字符。最终输出的HTML则有234个字符。纯HTML中标记字符甚至超过了文本本身。

使用Markdown的引用型链接,源文档更接近于最终的浏览器输出效果。再加上Markdown允许将标记有关的元数据移到段落之外,你尽管添加链接,而不必担心打断文件的故事情节。

自动链接

Markdown提供了一种快捷方式”自动地”定义链接和Email地址:直接用一对尖括号把URL或Email地址包住。这表示链接文本就是URL本身,Email文本就是Email本身。这样你就得到了一个可点击的链接,如:

http://example.com/
Markdown会将它转换为:

http://example.com/
自动Email地址工作方式相似,只有一点不同。Markdown自动的用一些十进制和十六进制数字表示你的Email,以防止遭遇垃圾邮件袭击。 例如:

address@example.com
会被转换为:

强调

Markdown使用星号()和下划线(_)作为表示强调。用一个 或 _ 包裹的文本会使用 HTML 标签包裹; 用两个 * 或 _包裹的文本会使用HTML 标签包裹。如:

f*single asterisks*

_single underscores_

**double asterisks**

__double underscores__

将会输出为:

<em>single asterisks</em>

<em>single underscores</em>

<strong>double asterisks</strong>

<strong>double underscores</strong>

你喜欢哪一种风格就用哪一种,唯一的限制就是起始字符与关闭字符必须一致。

强调符号可用于一个单词的一部分:

un*frigging*believable
不过如果你用空格包裹单独的 * 或 _,它们就失去了强调的含义,而成为字面上的星号或下划线。

如果不想让Markdown解释这两个元字符,就转义它:

\*this text is surrounded by literal asterisks\*

代码

要在行内表示部分代码,用反引号(`)包住它。与预格式代码块不同和,行内代码用于段落之内。例如:

Use the `printf()` function.

会生成:

<p>Use the <code>printf()</code> function.</p>

要在一个行内代码中使用反引号(`)本身,用多个反引号作为定界符包住它:

``There is a literal backtick (`) here.``

这样就会得到:

<p><code>There is a literal backtick (`) here.</code></p>

包住行内代码的反引号定界符可以包括空格--即在起始反引号之后,结束反引号之前可以有一个空格。这使得我们能够在行内代码的开始或结束处使用反引号:

A single backtick in a code span: `` ` ``

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

会生成:

<p>A single backtick in a code span: <code>`</code></p>

<p>A backtick-delimited string in a code span: <code>`foo`</code></p>

在行内代码中,&和<和>会自动编码为HTML实体,以方便包含HTML标签。Markdown会把下面这行:

Please don't use any `<blink>` tags.

转换为:

<p>Please don't use any <code><blink></code> tags.</p>

你也可以这样写:

`&#8212;` is the decimal-encoded equivalent of `&mdash;`.

会得到:

<p><code>&#8212;</code> is the decimal-encoded
equivalent of <code>&mdash;</code>.</p>

图片

必须承认,要以“自然的”语法把一个图片放到一个纯文本文档之中,确实是一个挑战。

Markdown使用了类似链接语法来表示图片,
同样有两种风格:行内图片和引用图片

行内图片语法示例:

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

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

即:

一个感叹号!开头;
其后紧跟一对中括号,中括号内存放图片的alt`属性;
其后紧跟一对小括号,小括号内存放图片的URL或路径,及可选的用双引号或单引号或小括号括起来的图片title

引用图片语法如下:

![Alt text][id]

这里 “id” 是图片引用标识。图片引用定义的语法与链接定义完全相同:

在写这篇文章时,Markdown还没有语法指定图片的大小,如果这一点对你特别重要,你可以直接使用标签。

反斜线转义

Markdown允许你使用反斜线转义那些Markdown元字符,让它们失去原有的“魔力”。举个例子,如果你确实想用星号包住一个词组(而不是想得到标签),就可以在星号之前使用反斜线将其转义。即:

*literal asterisks*
Markdown中,以下字符支持使用反斜线转义:

\   反斜线
`   反引号
*   星号
_   下划线
{}  大括号
[]  中括号
()  小括号
#   井号
+   加号
-   减号(连字符)
.   句点
!   感叹号

斜体、粗体、删除线

*斜体*或_斜体_
**粗体**
***加粗斜体***
~~删除线~~
<del>删除内容</del>

效果:
斜体斜体
粗体
加粗斜体
删除线
删除内容

内容目录

在段落中填写 [TOC] 以显示全文内容的目录结构。
效果参见最上方的目录

注脚

语法说明:

在需要添加注脚的文字后加上脚注名字[^注脚名字],称为加注。 然后在文本的任意位置(一般在最后)添加脚注,脚注前必须有对应的脚注名字。

注意:经测试注脚与注脚之间必须空一行,不然会失效。成功后会发现,即使你没有把注脚写在文末,经Markdown转换后,也会自动归类到文章的最后。

流程图
代码:

flow
st=>start: Start:>https://www.zybuluo.com
io=>inputoutput: verification
op=>operation: Your Operation
cond=>condition: Yes or No?
sub=>subroutine: Your Subroutine
e=>end
st->io->op->cond
cond(yes)->e
cond(no)->sub->io

显示效果:
flow
st=>start: Start:>https://www.zybuluo.com
io=>inputoutput: verification
op=>operation: Your Operation
cond=>condition: Yes or No?
sub=>subroutine: Your Subroutine
e=>end
st->io->op->cond
cond(yes)->e
cond(no)->sub->io

更多语法参考:流程图语法参考

表格

语法说明:

不管是哪种方式,第一行为表头,第二行分隔表头和主体部分,第三行开始每一行为一个表格行。
列于列之间用管道符|隔开。原生方式的表格每一行的两边也要有管道符。
第二行还可以为不同的列指定对齐方向。默认为左对齐,在-右边加上:就右对齐。
代码:

简单方式写表格:

学号|姓名|分数
-|-:|-
小明|男|75
小红|女|79
小陆|男|92

效果图:

学号姓名分数
小明75
小红79
小陆92

原生方式写表格:

|学号|姓名|分数|
|-|-|-|
|小明|男|75|
|小红|女|79|
|小陆|男|92|

效果图:

学号姓名分数
小明75
小红79
小陆92

为表格第二列指定方向:

产品|价格
-|-:
Leanote 高级账号|60元/年
Leanote 超级账号|120元/年

显示效果:

产品价格
Leanote 高级账号60元/年
Leanote 超级账号120元/年
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值