内容包含
- 区块元素
- 段落和换行
- 标题
- 区块引用
- 列表
- 代码区块
- 分隔线
- 区段元素
- 链接
- 强调
- 代码
- 图片
- 其他
- 自动链接
- 反斜杠
区块元素
段落和换行
段落之间需要有一个或者多个空行来分隔
这里就是第二段
第二段
段内换行,需要两个空格加一个回车
标题
用 # 号来处理表示 H1
两个 # 号来表示 H2
以此类推, 如
# 一级标题
## 二级标题
### 三级标题
显示如下:
一级标题
二级标题
三级标题
区块引用
引用一个区块,用 > 来表示
如
> 这里是区块引用的内容
效果如下:
这里是区块引用的内容
区块引用可以嵌套,如
> 这里是外层引用
>> 内层引用多加一个 > 符号
>>> 再内层
效果如下:
这里是外层引用
内层引用多加一个 > 符号
再内层
列表
列表分为 无序列表 和 有序列表
无序列表
无序列表是在文本前加 * 号
如
* 无序列表项1
* 无序列表项2
* 无序列表项3
* 无序列表项4
效果如下:
- 无序列表项1
- 无序列表项2
- 无序列表项3
- 无序列表项4
有序列表
有序列表是在文本前加 1. 2. 3.
如:
1. 有序列表项1
2. 有序列表项2
3. 有序列表项3
4. 有序列表项4
效果如下:
- 有序列表项1
- 有序列表项2
- 有序列表项3
- 有序列表项4
代码区块
代码区块是在文本后空一行,在缩进4个空格
这里就是代码区块
代码区块里的文本不会解析MarkDown语法,如 *没有强调效果*
## 没有标题效果
代码区块在没有缩进的文本时就结束了
分隔线
以下方法都可以表示分隔线
* * *
***
*****
- - -
---------------------------------------
区段元素
链接
链接分为行内式和参考式两种
行内式
用 [] 把需要链接的文本包含起来,然后在其后面用小括号包含URL
如
百度的首页:[百度](https://www.baidu.com)
效果如下:
百度的首页: 百度
参考式
参考式先用 [文本][资源id] 的形式占位,然后在其他地方指定URL,后面的 资源id 可以省略,会把文本当做id
如
百度的首页: [百度][baidu] 或 [百度][]
在其他空白的地方定义百度的URL,形如
[baidu]: https://www.baidu.com "百度首页"
[百度]: https://www.baidu.com "百度首页"
后面的字符串只是一个描述
强调
用 一对 ** 符号 或者 __ 符号把需要强调的词包含起来
如
这里有一个 *重要的会议* ,请_准时_参加
效果如下
这里有一个重要的会议,请 准时 参加
代码
段落中的代码
在一段文本段落中,用一对 ` 号把代码包含起来
如
在Swift语言中,打印函数是`print()`
如打印Hello World! 就这样 `print("Hello World!")`
效果如下
在Swift语言中,打印函数是print()
如打印Hello World! 就这样 print("Hello World!")
一段代码
如果要单独引入一段代码,可以用一对三个 ` 符号把一段代码包含在内
如
```Swift // 这里可以语法高亮的语言
// 这里用for循环打印10次Hello World!
for _ in 1...10 {
print("Hello World!")
}
```
效果如下
// 这里用for循环打印10次Hello World!
for _ in 1...10 {
print("Hello World!")
}
图片
引入图片也有行内式和参考式两种,目前MarkDown还没有指定图片宽高的方法,如果需要用<img>
标签
行内式
和链接类似,只是在链接的形式前加了个 ! 号
如
![猫咪](http://upload-images.jianshu.io/upload_images/4300331-91f2633dc312cf64.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
![狗狗](http://upload-images.jianshu.io/upload_images/4300331-d9174e22144e9505.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
效果如下
参考式
参考式和链接类似,也可以先占位,然后在其他地方指定图片的URL
如
// 后面的括号指定ID
![Cat][catURL]
![Dog][dogURL]
// 也可以把简写ID,会把文本当成ID
![Cat2][]
![Dog2][]
// 在其他位置指定id的对应的URL
[catURL]: http://upload-images.jianshu.io/upload_images/4300331-91f2633dc312cf64.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240
[dogURL]: http://upload-images.jianshu.io/upload_images/4300331-d9174e22144e9505.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240
[Cat2]: http://upload-images.jianshu.io/upload_images/4300331-91f2633dc312cf64.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240
[Dog2]: http://upload-images.jianshu.io/upload_images/4300331-d9174e22144e9505.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240
效果如下
其他
自动链接
MarkDown支持用简短的形式来表示网址和邮箱,只需要用<>把网址和邮箱地址包含起来
如
百度地址<https://www.baidu.com>
给我发邮件<dancewithpeng@gmail.com>
效果如下
百度地址https://www.baidu.com
给我发邮件dancewithpeng@gmail.com
反斜杠
可以用反斜杠在MarkDown文档中表示的字符
\ 反斜线
` 反引号
* 星号
_ 底线
{} 花括号
[] 方括号
() 括弧
# 井字号
+ 加号
- 减号
. 英文句点
! 惊叹号