Markdown语法简要说明

Markdown语法

注意Markdown中使用到的语法符号均为英文符号

Markdown语法主要分为如下几大部分:
标题段落区块引用强调列表分割线链接图片反斜杠符号等。


一、 标题

标题有两种形式:
第一种:使用=-来标记一级标题和二级标题

一级标题
=======

二级标题
-------

效果如下:

一级标题

二级标题

第二种:使用#可以表示1~6级标题

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

效果如下

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

二、 段落

一个Markdown段落是由一个或者多个连续的文本行组成,段落的前后需要有一个以上的空行(空行的定义是该行只包含空格和制表符)。Markdown允许段落内强制换行,方式是使用两个以上的空格再加上回车。


三、 区块引用

在段落的每一行使用符号>来表示该段落是区块引用,区块引用可以嵌套
例子:

>区块引用
>>嵌套引用

效果如下:

区块引用

嵌套引用

PS:可以多层嵌套,类似标题的语法,通过添加>的个数来进行多层嵌套,例如三层嵌套使用:>>>


四、代码区块

要在Markdown中建立代码区块,只需要缩进4个空格或者一个制表符。
或者将代码放在 ``` 符号划分的区域内。```后面的单词表示区块内的代码是哪种语言
例:使用 ```

```javascript
console.log("代码区块");
```

效果:

console.log("代码区块");

五、强调

Markdown使用星号(*)或者下划线(_)来标记强调的符号 ,一个符号表示斜体,两个符号表示粗体。
例子:

*斜体*, *粗体*
_斜体_,_粗体_

效果:

斜体粗体
斜体, 粗体

注意:标记符号和文字之间不能有空格


六、列表

Markdown支持无序列表和有序列表
无序列表使用星号(*),加号(+)或者减号(-)来标记
例子:

使用星号(*
* 第一项
* 第二项
* 第三项

使用加号(+
+ 第一项
+ 第二项
+ 第三项

使用减号(-
- 第一项
- 第二项
- 第三项

效果:

使用星号(*

  • 第一项
  • 第二项
  • 第三项

使用加号(+

  • 第一项
  • 第二项
  • 第三项

使用减号(-

  • 第一项
  • 第二项
  • 第三项

七、分隔线

在一行中使用三个以上的星号(*)、减号(-)或者下划线(_)来建立一个分隔线,行内不能有其他东西。
例子:

使用星号(*
***
使用减号(-
---
使用下划线(_
___

效果:

使用星号(*


使用减号(-


使用下划线(_



八、链接

Markdown支持两种形式的链接语法: 行内式参考式
不管是哪一种方式,链接文字都是用[方括号]来标记。

行内式只需要在方括号后紧接着加上(圆括号)并在圆括号内插入链接即可,如果还想加上链接的title文字(title文字表示鼠标悬浮在该链接上时显示的提示文字),只要在链接后面,用双引号把title文字包起来即可,链接和title文字之间需要使用空格来隔开,title文字是可选的。

参考式是在方括号后再接上另一个方括号,在第二个方括号内填入用于辨识链接的标识。title文字和行内式一致,选择性地加在链接之后,用双引号包裹起来。

例子:

行内式:
[Markdown语法说明](http://www.appinn.com/markdown/ "title文字")

参考式:
[Markdown语法说明][id]
[id]:http://www.appinn.com/markdown/ "title文字"

效果:

行内式:
Markdown语法说明(行内式)

参考式(有些工具可能未实现,推荐使用行内式):
[Markdown语法说明(参考式)][id]
[id]:http://www.appinn.com/markdown/ "title文字"


九、图片

图片的使用方式和链接的使用方式类似,只是需要在第一个方括号前加上!,里面的文字替换为图片的描述文字,图片也支持行内式参考式两种方式。
例子:

行内式:
![图片描述文字](https://s4.music.126.net/style/web2/img/default/default_album.jpg "title文字")

参考式(有些工具可能未实现,推荐使用行内式):
![图片描述文字][id]
[id]:https://s4.music.126.net/style/web2/img/default/default_album.jpg "title文字"

效果:

行内式:

图片描述文字

参考式(有些工具可能未实现,推荐使用行内式):
![图片描述文字][id]
[id]:https://s4.music.126.net/style/web2/img/default/default_album.jpg "title文字"


十、反斜杠

反斜杠的作用是转义,转义是指让特殊符号表示其原本的意思,成为不具有Markdown语法的普通符号。
Markdown使用了一些特殊符号来定义一些文字的格式,例如斜体或粗体,我们使用*号来标记,但是当我们需要在页面上呈现星号(*)而不使用它在Markdown中的语法时,需要在星号(*)前加上反斜杠(\),形如:\*。
Markdown支持以下符号在前面加上反斜杠来帮助插入普通符号:

\ 反斜杠 \
` 反引号 \`
* 星号 \*
_ 下划线 \_
{} 花括号 \{}
[] 方括号 \[]
() 圆括号 \()
# 井号 \#
+ 加号 \+
- 减号 \-
. 英文句点 \.
! 感叹号 \!


十一、反引号 `

反引号起到标记作用。
例如:

`标记`

效果:

标记


十二、复选框

复选框包含选中和未选中两种形式。复选框使用减号(-)后紧接一个方括号([])来表示。减号和方括号之间有一个空格,方括号内加上小写英文字母(x)来表示选中的复选框,方括号内加上一个空格表示未选中的复选框。
例:

选中:
- [x] 选中的复选框

未选中:
- [ ] 未选中的复选框

效果:

选中:

  • [x] 选中的复选框

未选中:

  • [ ] 未选中的复选框

十三、表格

使用markdown可以很容易地将数据进行表格展示。表格的每一列使用|隔开,表头(header)和内容之间使用---来分隔。
例:

header 1 | header 2 | header 3
---|---|---
row 1 col 1 | row 1 col 2 | row 1 col 3
row 2 col 1 | row 2 col 2 | row 2 col 3

header 1 header 2 header 3
row 1 col 1 row 1 col 2 row 1 col 3
row 2 col 1 row 2 col 2 row 2 col 3

效果如下:

header 1 header 2 header 3
row 1 col 1 row 1 col 2 row 1 col 3
row 2 col 1 row 2 col 2 row 2 col 3

Markdown还可实现流程图甘特图数学公式等,由于这些功能使用较少,就没一一列举,可以参考文末的参考文档,里面有更详尽的介绍。


参考文档链接:
Markdown 语法说明(简体中文版)
有道云笔记Markdown指南


PS:对于前端程序员推荐一款将Markdown的Text文本的字符串转为Html的工具:showdown
附上该工具的在线预览地址:Showdown Live Editor
以及github所使用的Markdown的样式:GitHub Markdown style

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

推荐阅读更多精彩内容