Hexo搭建的论坛是用Markdown来写文档的,这是一种轻量级的「标记语言」,一般写个文档,了解下常用的几个语法就可以了。
标题
标题可以用2钟方式,一钟是用”#“(井号),总共六级标题,分别在文字前用1到6个“#”号表示。
语法参考如下:1
2
3
4
5
6# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
另一种是在文字的下面加”=”(等号)或”-“(减号),分别表示一级和二级标题。
语法参考如下:1
2
3
4
5一级标题
========
二级标题
--------
粗体和斜体
斜体前后,各加一个”*“(星号)或”_“(下划线)表示,粗体前后,各加两个”*“(星号)或”_“(下划线)表示。
语法参考如下:1
2
3
4*斜体*
**粗体**
_斜体_
__粗体__
显示如下:
斜体
粗体
斜体
粗体
链接
链接分为行内式和参考式两种。
行内式用一对方括号包含显示的文字,紧接着一对圆括号放链接的地址和提示。
语法参考如下:1
访问[GitHub](https://github.com/ "Link to GitHub")
显示如下:
访问GitHub
参考式用两对紧挨的方括号,第二个方括号放链接的ID,并在文章的其他地方定义这个ID的内容。
语法参考如下:1
2
3访问[GitHub][link1]
[link1]: https://github.com/ "Link to GitHub"
显示如下:
访问GitHub
链接的地址可以是站内的相对地址。
自动链接
包括在一对尖括号里的地址或邮箱,也会被Markdown自动处理为链接。
语法参考如下:1
2访问<https://github.com/>
mailto: <address@example.com>
显示效果如下:
访问https://github.com/
mailto: address@example.com
区块引用
在要引用文字的每行开头增加一个”> “(大于号),注意和后面的内容要有空格,多个”> “还可以实现嵌套引用。
语法参考如下:1
2
3普通内容
> 引用内容
> > 嵌套引用内容
显示效果如下:
普通内容
引用内容
嵌套引用内容
代码
行内的代码,可以在前后各加一个”`“(反引号)来表示。
语法参考如下:1
使用命令 `pip install -U pip` 来更新pip。
显示效果如下:
使用命令 pip install -U pip
来更新pip。
大段的代码,可以是在每行的开头增加4个空格或一个制表符。
语法参考如下:1
2
3普通内容
#!/usr/bin/python
print('hello world!')
显示效果如下:
普通内容
#!/usr/bin/python
print('hello world!')
或者在代码前后各加一行,写三个”`“(反引号),如” ``` “。
在开头的三个反引号后面,还可以写代码的类型,实现语法高亮,如” ``` python “。
语法参考如下:
``` python
#!/usr/bin/python
print(‘hello world!’)
```
显示效果如下:1
2#!/usr/bin/python
print('hello world!')
图片
在文档中添加图片的语法和链接的语法很像,也分为行内式和参考式,和链接的区别是在前面增加了一个”!”(惊叹号)。
语法参考如下:1
2
3
4这是一个行内式添加的图片:![64 fire](/images/64_fire.jpg "64 fire")
这是一个链接式添加的图片:![64 fire][pic-1]
[pic-1]: /images/64_fire.jpg "64 fire"
显示效果如下:
这是一个行内式添加的图片:
这是一个链接式添加的图片:
分隔线
在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西,中间可以插入空格
语法参考如下:1
2
3
4
5***
* * *
*********
- - -
_________
上面几种显示效果均一样,如下:
列表
Markdown 支持有序列表和无序列表。
无序列表使用星号、加号或是减号作为列表标记
语法参考如下:1
2
3
4
5
6
7
8
9
10
11
12
13
14
15* 项目1
* 项目2
* 项目3
或
+ 项目1
+ 项目2
+ 项目3
或
- 项目1
- 项目2
- 项目3
上面三种,显示效果均一样,如下:
- 项目1
- 项目2
- 项目3
有序列表使用数字加一个英文句点作为列表标记。
语法参考如下:1
2
31. 项目1
2. 项目2
3. 项目3
显示效果如下:
- 项目1
- 项目2
- 项目3
事实上,数字的值并不重要,如以下2种写法,显示效果均和前面一样,序号都从1开始顺序排列。1
2
3
4
5
6
7
8
91. 项目1
1. 项目2
1. 项目3
或
3. 项目1
9. 项目2
6. 项目3
不过第一个项目的序号最好是1,因为Markdown以后可能会支持有序列表的start属性。
如果项目的信息有多行文字,为了美观可以在前面最多加3个空格保持缩进,也可以偷懒不加空格,如以下写法均可:1
2
3
4
5* 项目1
项目1-1
* 项目2
项目2-1
* 项目3
如果一段文字以数字加一个点开头,但不想让其变成一个有序列表,可以在点前加个反斜杠,无序列表的符号也是如此,如:1
21989\. this is s ...
\* this is s ...
表格
Markdown使用管线图的方式实现表格,如下表示一个简单的表格,注意表格的开头要空一行。
语法参考如下:1
2
3
4
5
标题1 | 标题2 | 标题3
:-----|-----:|:-----:
行1-内容1 | 行1-内容2 | 行1-内容3
行2-内容1 | 行2-内容2 | 行2-内容3
显示效果如下:
标题1 | 标题2 | 标题3 |
---|---|---|
行1-内容1 | 行1-内容2 | 行1-内容3 |
行2-内容1 | 行2-内容2 | 行2-内容3 |
注意上面第二行中的冒号,表示几种不同的对齐方式
为了美观,写的时候也可以尽量对齐,并在前后各加个”|”(下划线),如下面的写法,显示效果和前面一样1
2
3
4
5
| 标题1 | 标题2 | 标题3 |
|:----------|----------:|:---------:|
| 行1-内容1 | 行1-内容2 | 行1-内容3 |
| 行2-内容1 | 行2-内容2 | 行2-内容3 |
反斜杠
如果需要在文档中显示一下Markdown语法相关的字符,不希望Markdown将其按语法字符处理,可以在前面增加一个反斜杠,在前面的介绍列表时已经有这样的用法。