注意:同一份.md文档在github中解析的规则和简书解析的规则并不一样,写这个说明书的时候发现了github不支持目录、代码块嵌套必须换行、不支持表格
Github对应地址
目录
在需要生成目录的地方写上[TOC]就可以啦
[TOC]
1、标题
使用#表示标题,一级标题使用一个#,二级标题使用两个##,以此类推,共有六级标题。
使用==表示高阶标题,使用--表示次阶标题。(ps:=或-的数目不小于两个,且中间不能有空格)
# 一级标题
一级标题
## 二级标题
二级标题
高阶标题
==
高阶标题
低阶标题
--
低阶标题
2、层级引用
使用>表示引用,>>表示引用里面再套一层引用,依次类推。
> 这是单个一级引用
这是单个一级引用
> 这是一级引用
>> 这是二级引用
这是一级引用
这是二级引用
> 这是一级引用
>> 这是二级引用(降级时后面需要空一行)
> 这是一级引用
>> 这是二级引用
这是一级引用
这是二级引用(这里降级时后面空了一行然后正常显示)
这是一级引用
这是二级引用
如果引用嵌套使用的话,从高(如:>>>)退到低(如:>)时,必须之间要加一个空格或者>作为过渡,否则默认下一行和上一行是同一级别的引用。引用标记里可以使用其他标记,如有序列表或无序列表标记,代码标记等。
3、代码引用
3.1、代码块
使用```表示代码块(也可以用来进行预格式),在```后面加上语言类型还能进行语法高亮
```javascript
var canvas = document.getElementById("canvas");
var context = canvas.getContext("2d");
```
var canvas = document.getElementById("canvas");
var context = canvas.getContext("2d");
` 这个符号的键是在esc键的下面,切换到英文下即可。
3.2、行内代码
使用 `...`表示行内代码
这是`javascript`代码
这是javascript
代码
4、链接
4.1、直接插入网站链接
直接把链接复制粘贴即可,如:http://www.jianshu.com/
4.2、插入文本链接
格式为:[显示文本](文本对应链接)
[简书](http://www.jianshu.com/)
4.3、插入图片链接
格式为:![](对应图片链接)
![熊孩子](http://upload-images.jianshu.io/upload_images/329784-d0eb7c0517dbc2df.jpeg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
(简书网站的编辑器中)对于本地的图片,会不知道地址怎么找。其实不用想的太复杂,你直接把图片拖进来,Markdown会直接帮你转换成图片输出,你只需要把 [ ] 中的文本换成你自己需要命名的图片名称就行了,根本不必去找一些图片地址生成工具。
5、列表(注意标记和内容之间有空格)
使用1. 2. 3.表示有序列表,使用或-或+表示无序列表*
5.1、有序列表
1. 第一点
2. 第二点
4. 第四点(这里会自动纠正)
- 第一点
- 第二点
- 第四点(这里已经自动纠正)
有序列表嵌套,注意缩进
1. 第一点
1. 第一点
2. 第二点
3. 第三点
2. 第二点
1. 第一点
1. 第一点
2. 第二点
3. 第三点
2. 第二点
3. 第三点
3. 第三点
- 第一点
- 第一点
- 第二点
- 第三点
- 第二点
- 第一点
- 第一点
- 第二点
- 第三点
- 第二点
- 第三点
- 第一点
- 第三点
5.2、无序列表(书写时注意缩进)
+ 子列表1
+ 子列表2
- 子子列表1
- 子子列表2
* 子子子列表1
* 子子子列表2
* 子子子列表3
- 子子列表3
+ 子列表3
- 子列表1
- 子列表2
- 子子列表1
- 子子列表2
- 子子子列表1
- 子子子列表2
- 子子子列表3
- 子子列表3
- 子列表3
注意:
1.有序列表标记不是按照你写的数字进行显示的,而是根据当前有序列表标记所在位置显示的.
2.无序列表的项目符号是按照实心圆、空心圆、实心方格的层级关系递进的,通常情况下,同一层级使用同一种标记表示,便于自己查看和管理。
markdown会自动忽略句首的空格,可以改用全角空格(Windows用shift+空格键转换)
6、字体格式(注意标记和内容之间没有空格)
使用 * 或者 _ 表示斜体。
使用 ** 或者__ 表示粗体。
正常
*斜体1*
斜体1
_斜体2_
斜体2
**粗体1**
粗体1
__粗体2__
粗体2
***粗斜体1***
粗斜体1
___粗斜体2___
粗斜体2
~~删除线~~
删除线
分割线前后为了避免与相邻的格式符号产生影响所以最都要空行
分割线1---
分割线2 ***
转义符(反斜杠“\”)
有时候你在输入了某些字符后,原本希望以文本显示的,但是却变成了其他格式。最简单的方法就是,在这些字符前面加上反斜杠 “
” ,这时候这些字符就被看
作是纯文本,没有任何特殊作用了,当然就不会影响后面内容的输出了。
一个 “” 只作用于紧跟其后的一个完整意义字符或者字符串,如果是多个字符或
者字符串形成某种格式转换,而你又想把这些以文本形式输出,那么就需要在多处加上反斜杠了。
7、表格
-: 为右对齐
:- 为左对齐
:-: 为居中对齐
- 为默认左对齐
7.1、普通表格
|A|B|C|
|-|-|-|
|A1|B1|C1|
|A2|B2|C2|
A | B | C |
---|---|---|
A1 | B1 | C1 |
A2 | B2 | C2 |
7.2、文艺表格
|左对齐|居中|右对齐|
|:-|:-:|-:|
|A1|B1|C1|
|A2|B2|C2|
左对齐 | 居中 | 右对齐 |
---|---|---|
A1 | B1 | C1 |
A2 | B2 | C2 |
7.3、二逼表格
|A|B|C|
|-|-|-|
|**粗体**|*斜体*|~~删除~~|
|__另一种粗体__|_另一个斜体_|`段内代码`|
|[超链接也可以](http://www.baidu.com)| |脚注[^fn1]|
A | B | C |
---|---|---|
粗体 | 斜体 | |
另一种粗体 | 另一个斜体 | 段内代码 |
超链接也可以 | 脚注[^fn1] |