markdown基本语法

1. 标题

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

类 Setext 形式是用底线的形式,利用 = (最高阶标题)和 - (第二阶标题),例如:

This is an H1
=============

This is an H2
-------------  

效果如下(任何数量的 = 和 - 都可以有效果。):

This is an H1

This is an H2

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

# 这是 H1

## 这是 H2

###### 这是 H6 

效果如下:

这是 H1

这是 H2

这是 H6

2. 区块引用 Blockquotes

Markdown 标记区块引用是使用类似 email 中用 > 的引用方式。如果你还熟悉在 email 信件中的引言部分,你就知道怎么在 Markdown 文件中建立一个区块引用,那会看起来像是你自己先断好行,然后在每行的最前面加上 > :

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
>
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse   

效果如下:

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse

Markdown 也允许你偷懒只在整个段落的第一行最前面加上 > :

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
  consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.

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

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");

3. 列表

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

无序列表使用星号、加号或是减号作为列表标记(三者等同):

*   Red
*   Green
*   Blue

+   111
+   222
+   333

-   Red
-   Green
-   Blue

效果如下:

  • Red
  • Green
  • Blue
  • 111
  • 222
  • 333
  • Red
  • Green
  • Blue

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

1.  Bird
2.  McHale
3.  Parish    

效果如下

  1. Bird
  2. McHale
  3. Parish

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

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

4. 代码区块

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

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

这是一个普通段落:

这是一个代码区块。

效果如下:

这是一个代码区块。

一个代码区块会一直持续到没有缩进的那一行(或是文件结尾)。


5. 分隔线

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

  * * *

  ***

  *****

  - - -

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

效果如下:






6. 区段元素 - 链接

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

不管是哪一种,链接文字都是用 [方括号] 来标记。

要建立一个行内式的链接,只要在方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 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] [id] reference-style link.
接着,在文件的任意处,你可以把这个标记的链接内容定义出来:

[id]: 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.

7. 强调

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

  *single asterisks*

  _single underscores_

  **double asterisks**

  __double underscores__   

效果如下:

single asterisks

single underscores

double asterisks

double underscores

8. 代码

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

效果如下:

Use the printf() function.

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

There is a literal backtick (`) here.

效果如下:

There is a literal backtick (`) here.

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

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

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

效果如下:

A single backtick in a code span: `

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

在代码区段内,& 和尖括号都会被自动地转成 HTML 实体,这使得插入 HTML 原始码变得很容易

9. 图片

很明显地,要在纯文字应用中设计一个「自然」的语法来插入图片是有一定难度的。

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 还没有办法指定图片的宽高,如果你需要的话,你可以使用普通的<img>标签。

本地图片上传

登陆http://yotuku.cn/
上传图片,点击markdown,粘贴到markdown文档即可

10. 删除线

GFM增加了删除线
~~Mistaken text.~~

效果如下:

Mistaken text.

11. 代码块

如果有一整块代码需要包围, 可以使用```
例如:

x = 0
x = 2 + 2
what is x

效果如下:

x = 0
x = 2 + 2
what is x

12. 语法高亮

代码块可以使用语法高亮了!!在你的代码块中添加一个可选的语言标识符,我们会通过语法高亮显示运行它。例如,为了语法高亮ruby代码:

require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html

效果如下:

require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html

13. 表格

你可以创建表格,通过符号-分开第一行和其他行,通过|分开各个列

姓名 | 年龄 | 班级
-----|-----|-----
张三 | 28607 | 396班
王五 | 30 | 4班   

效果如下:

姓名 年龄 班级
张三 28607 396班
王五 30 4班

在标题行包含:,你可以使得表格向左对齐,向右对齐,居中

:在最左边表示左对齐,:在最右边表示右对齐,左右两边都有:表示居中。

|姓名 | 年龄 | 班级|
|:-----:|:-----:|:-----:|
|张三 | 28607777 | 3967777班|
|王五 | 30 | 4班 |   

效果如下:

姓名 年龄 班级
张三 28607777 3967777班
王五 30 4班

使用atom编辑markdown文本

atom编辑器支持markdown文本的预览(需要安装markdown preview插件,默认已安装),编辑文本的时候,快捷键ctrl-shift-M 即可打开markdown preview功能;
markdown preview插件信息可通过File->Settings->Filter packages输入框输入markdown preview->keybindings

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

推荐阅读更多精彩内容