Markdown使用入门简介
目录
-
- 基本用法
* 1.1 标题
* 1.2 格式
* 1.3 特殊符号
* 1.4 列表
* 1.5 引用
- 基本用法
- 2 代码区块与代码高亮
- 3 链接
* 3.1 链接
* 3.2 内链接
* 3.3 图片
* 3.4 自动链接 - 4 公式
- 5 表格
Markdown是一种轻量级的标记语言,能够让使用者用纯文本格式编写文档,然后再转换成格式丰富的html语言。Markdown编译器也支持HTML格式的编写规则。
1 基本用法
1.1 标题
标题由1~6个#
表示,分别表示层级为1到6的标题。
例子:
# 这是第一级标题
## 这是第二级标题
### 这是第三级标题
#### 这是第四级标题
##### 这是第五级标题
###### 这是第六级标题
效果:
这是第五级标题
这是第六级标题
1.2 格式
加粗
由前后两个星号**xxx**
表示
例子:
**这个是星号加粗的文本**
效果:
这个是星号加粗的文本
斜体
由前后一个星号*xx*
表示
例子:
*这个是斜体的文本*
效果:
这个是斜体的文本
删除
由前后两个波浪线~~xxx~~
表示
例子:
~~这个是删除的文本~~
例子:
这个是删除的文本
1.3 特殊符号
分隔线
分隔线可以在一行中使用三个或者三个以上的星号***
(测试时会和加粗、斜体混用,不推荐)、减号---
、下划线___
来建立。符号中间可以含有空格,但是不能含有其他符号。三种符号可以混用,只要满足个数大于等于3即可。
例子:
- - -
_ _ _
*混用:*
-*-
__*-
效果:
混用:
--
__-
1.4 列表
MarkDown支持有序列表以及无序列表两种,并且列表可以嵌套使用。不管是否为有序列表,都需要在标识符后加上一个空格。
有序列表
有序列表使用数字与英文句点1. xxx
作为标记。有序列表的数字顺序不会自动调整,如果标识的是什么数字就是什么顺序。
例子:
1. 列表1
2. 列表2
1. 列表2-1
1. 列表2-1-1
2. 列表2-2
3. 列表3
效果:
- 列表1
- 列表2
1. 列表2-1
1. 列表2-1-1
2. 列表2-2 - 列表3
无序列表
无序列表中使用星号* xxx
或者加号+ xxx
或者减号- xxx
标记。
例子:
* 列表1
- 列表2
+ 列表3
效果:
- 列表1
- 列表2
- 列表3
注意:
- 如果一个列表项目中含有多段内容,列表标识符后的各个段落需要段首缩进4个空格或一个制表符。
- 如果要在列表项目中添加引用,也需进行缩进。
- 列表项目中添加代码块,需要缩进8个空格或者两个制表符。
- 如果要避免产生不必要的列表项,则在
1. xx
的点之前添加反斜杠1\. 这不是列表项
。
1.5 引用
如果是引用的内容,需要在每一行前加上>
标识。引用中可以嵌套其他Markdown的语法,包括标题、列表、代码区块等。
例子:
>这是一个引用
>>这个是引用中的引用
> *This* `is` a **Test**
效果:
这是一个引用
这个是引用中的引用
Thisis
a Test
2 代码区块与代码高亮
- 简单的,只要在每行缩进四个空格或者一个制表符,就可以形成一个代码区块。
例子:
private int a;
private long b;
效果:
private int a;
private long b;
- 在一段代码的前后添加三个反分号```
例子:
```csharp
private int a;
private long b;
``````
**效果:**
```csharp
private int a;
private long b;
```
3. 代码高亮
在用反分号进行代码块的标识时,可以添加代码的类型,用来显示代码高亮。
| 代码类型| 标识 |
| ------------- |:-------------|
| C# | csharp |
| JavaScript | javascript|
| Java | java|
| C++ | c++ |
| Python| python|
# 3 链接
# 3.1 链接
markdown的链接分为两种形式
1. [链接文字] (链接地址),这种方法称为**行内式**链接。
**例子:**
**效果:**
[这个是百度的链接](www.baidu.com)
2. [链接文字] [参考地址],这种方法称为**参考式**链接。
首先,在第二个方括号中填入用来表示链接的标记。
`This is [an example][id] reference-stlelink.`
然后,在文件中的任意处,用标记把链接的具体内容标识出来。
`[id]: http://baidu.com/ "Option title"`
**效果:**
This is [an example][id] reference-stlelink.
## 3.2 内链接
由于Markdown语法自身不支持对内容内部类型的定义,因此可以利用设置锚点的方式进行内链接的实现。(在Evernote中可以实现内链接)
首先,可以在需要进行链接的地方定义锚点:
`<a name="mou">锚点</a>`
然后,用Markdown定义的链接方式调用该锚点:
`[链接到锚点](#mou)`
**效果:**
链接到锚点
## 3.3 图片
在Markdown中用一种与链接相似的方法进行图片的插入,包括**行内式**与**参考式**。
1. 行内式
* 感叹号`!`
* 方括号放上图片的说明文字`[这是一个图片]`
* 括号中放上图片的地址,选择性的是否添加'title'文字
**例子**
**效果**
![This is a picture](//upload-images.jianshu.io/upload_images/1413212-1b6e4772df75ff99.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
## 3.4 自动链接
如果将邮箱地址或者网址用`<>`包起来Markdown自动将其转换成链接。
**例子:**
http://baidu.com
example@sina.com
**效果:**
<http://baidu.com>
<example@sina.com>
# 4 公式
Markdown的公式主要靠解析公式的内容,并且将其转换为图片+链接的方式显示。不同的解释器可能解析的结果不同。
**例子:**
`$-b \pm \sqrt{b^2 - 4ac} \over 2a$ `
**效果:**
$-b \pm \sqrt{b^2 - 4ac} \over 2a$
# 5 表格
Markdown中的表格绘制包括表头、对其方式、内容三个部分。
1. 表头主要包括表格的主要字段的名称。
2. 对其设置中,`:`的位置决定了对其的位置,`:`在哪边就是靠哪边对其。如果两边都有,则居中,两边都没有,则表示按照默认对其方式对其。
3. 表格内容。
代码类型 | 标识 |
---|---|
C# | csharp |
JavaScript | javascript |
代码类型 | 标识 |
---|---|
C# | csharp |
JavaScript | javascript |
代码类型| 标识
------------- |:-------------
C# | csharp
JavaScript | javascript
| 代码类型| 标识 |
| ------------- |:-------------|
| C# | csharp |
| JavaScript | javascript|
[id]: <http://baidu.com/> " Option title"