markdown 语法
Markdown 的语法全由一些符号所组成,这些符号经过精挑细选,其作用一目了然
兼容 HTML
在 HTML 区块标签间的 Markdown 格式语法将不会被处理
例:
<p>欢迎使用Markdown 文档格式编写文档!</p>
效果:
<p>欢迎使用Markdown 文档格式编写文档!</p>
1. 区块元素
段落和换行
段落:
是由一个或多个连续的文本行组成,它的前后要有一个以上的空行。
空行的定义是显示上看起来像是空的,便会被视为空行。
比方说,若某一行只包含空格和制表符,则该行也会被视为空行
换行:
在插入处先按入两个以上的空格然后回
例:
你好,中国!
这是一封来自大山的信!
效果:
你好,中国!
这是一封来自大山的信!
标题
在行首插入 1 到 6 个 # ,对应到标题 1 到 6 阶
例:
# h1标题
## h2号标题
### h3号标题
#### h4号标题
##### h5号标题
###### h6号标题
效果:
h1标题
h2号标题
h3号标题
h4号标题
h5号标题
h6号标题
区块引用 Blockquotes
行最前面加上 >
例:
> 今天天气不错!
> > --左霄红
效果:
今天天气不错!
--左霄红
列表
无序列表使用星号、加号或是减号作为列表标记
有序列表则使用数字接着一个英文句点
例:
* 北京
* 天津
* 山西
1. 北京
2. 上海
3. 广州
效果:
- 北京
- 天津
- 山西
- 北京
- 上海
- 广州
代码区块
行首缩进 4 个空格或是 1 个制表符就可以建立代码区块
例:
这里是测试信息
效果:
这里是测试信息
分隔线
在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西
例:
---
___
***
效果:
2. 区段元素
链接
只要在方块括号后面紧接着圆括号并插入网址链接即可
例:
[百度](http://baidu.com)
> 君不见,黄河之水天上来,奔流到海不复回。
————[李白](http://baike.baidu.com/link?url=s9TDLrw3cIwB4M_epaF9pFzpskmvBjTtdhHAT4yptDQJmKwvWg2pk60uXG1SbI_0VYuIFy5hx68B054vhYMEtcUD3C4filz8bL_9lJCVe4S)《将进酒》
![李白](http://upload-images.jianshu.io/upload_images/2666050-f2e9ac135450b8cd.jpg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
效果:
君不见,黄河之水天上来,奔流到海不复回。
————李白《将进酒》
强调
Markdown 使用星号( * )作为标记强调字词的符号
被一个 * 包围的字词会被转成用 <em>
被两个 * 包起来的话,则会被转成 <strong>
例:
*this is a test*
**你好!中国**
效果:
this is a test
你好!中国
代码
如果要标记一小段行内代码,你可以用反引号把它包起来( `)
例:
`var_dump($name)`
效果:
var_dump($name)
如果要标记大段多行代码,你可以用三个反引号把它包起来( ``` )
例:
```
public function test()
{
echo __LINE__;
}
```
效果:
public function test()
{
echo __LINE__;
}
图片
· 一个惊叹号 !
· 接着一个方括号,里面放上图片的替代文字 [文字]
· 接着一个圆括号,里面放上图片的网址 (网址)
例:
![李白](http://upload-images.jianshu.io/upload_images/2666050-f2e9ac135450b8cd.jpg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
效果:
表格
例:
| 列1 | 列2 | 列3 |
| --- | --: | :-: |
| 天津| 128 | 28 |
效果:
列1 | 列2 | 列3 |
---|---|---|
天津 | 128 | 28 |
3. 其它
自动链接
Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱
只要是用尖括号包起来<>, Markdown 就会自动把它转成链接。
一般网址的链接文字就和链接地址一样
例:
<http://baidu.com>
<feng7396553@163.com>
效果:
反斜杠
利用反斜杠来插入一些在语法中有其它意义的符号
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:
\ 反斜线
` 反引号
* 星号
_ 底线
{} 花括号
[] 方括号
() 括弧
# 井字号
+ 加号
- 减号
. 英文句点
! 惊叹号
例:
\# 中国
效果:
# 中国