Markdown简明教程

Markdown

什么是Markdown

Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber)。它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档”。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。

普遍来说,Markdown 是一种方便记忆、书写的纯文本标记语言,用户可以使用这些标记符号以最小的输入代价生成极富表现力的文档:譬如您正在阅读的这份文档。它使用简单的符号标记不同的标题,分割不同的段落,粗体 或者 斜体 某些文字,更棒的是,它还可以

书写一个质能守恒公式

$$E=mc^2$$

高亮一段代码

1
2
3
4
5
6
7
@requires_authorization
class SomeClass:
pass

if __name__ == '__main__':
# A comment
print 'hello world'

绘制一个表格

years Month day
1920 10 5
1930 5 4
1940 4 7

在此,我们总结 Markdown 的优点如下:

  • 纯文本,所以兼容性极强,可以用所有文本编辑器打开。
  • 让你专注于文字而不是排版。
  • 格式转换方便,Markdown 的文本你可以轻松转换为 html、电子书等。
  • Markdown 的标记语法有极好的可读性。

Markdown是一种简单的『标记语言』,语法比较简单,内容少,故本文将会以一行语法一个示例的形式展示,轻松易懂。同时本文也作为我个人的参考文档,在遗忘时可以通过ctrl+f寻找。

By the way,推荐一个cmd Markdown编辑器,目测是支持中文最好的编辑器

语法格式

标题

Markdown 支持两种标题的语法,类 Setext 和类 atx 形式。

Setext 形式是利用 = (最高阶标题) 和 - (第二阶标题)。

任何数量的 '=' 和 '_' 都有效果
This is an h1
===

This is an h2
---

atx 形式则是在行首插入 1 到 6 个 #,对应 h1 ~ h6.

# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题

列表

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

无序列表 使用 *+ 或是 - 作为列表标记符号

* Red
* Green
* Blue

等同于:

+ Red
+ Green
+ Blue

等同于:

- Red
- Green
- Blue
  • Red
  • Green
  • Blue

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

1. Red
2. Green
3. Blue

1.Red
2.Green
3.Blue

链接

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

行内式

[从善如水](http://zehuiguan.github.io/ "Z.H.Kwan的博客")

从善如水

参考式

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.

图片

跟链接一样,图片也有 行内式 和 参考式 两种。

行内式

形式大概如下:

  • 一个惊叹号 !
  • 接着一个方括号,里面放上图片的替代文字
  • 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上 选择性的 ‘title’ 文字。
1
![GitHub Mark](http://github.global.ssl.fastly.net/images/modules/logos_page/GitHub-Mark.png "GitHub Mark")

GitHub Mark

参考式

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

![Alt text][id]

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

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

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

强调

Markdown 使用星号 * 和底线 _ 作为标记强调字词的符号,可用于文字中间的词语。

我要 *强调* 这句话。

我要 _强调_ 这句话。

我要 强调 这句话。

我要 _强调_ 这句话。

代码

标记小段代码

Use the `printf()` function.

Use the printf() function.

普通文字块

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

这是一个普通段落:

    这是一个代码区块。

这是一个普通段落:

这是一个代码区块。

高亮代码块

三个`是连续的,没有空格

`` `html
// html
<img src="/image-url" class="full-image" />
<img src="/image-url" class="full-image" />
<img src="/image-url" class="full-image" />
<img src="/image-url" class="full-image" />
`` `

A backtick-delimited string in a code span: `

1
2
3
4
5
// html
<img src="/image-url" class="full-image" />
<img src="/image-url" class="full-image" />
<img src="/image-url" class="full-image" />
<img src="/image-url" class="full-image" />

引用

在希望引用的文字前加 ‘>’。

> 人的一切痛苦,本质上都是对自己的无能的愤怒。

人的一切痛苦,本质上都是对自己的无能的愤怒。

分割线

在一行中用三个以上的星号、减号来建立一个分割线

---

***


结语

以上几种格式是比较常用的格式,基本够用。Markdown的语法还有很多,详细可以参考Markdown 语法说明 (简体中文版)

参考文献

DONE!!!