Markdown

什么是Markdown

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建,编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档,文档后缀为 .md, .markdown。

当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。


标题

使用 # 号标记
使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。

1
2
3
4
5
6
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

段落

Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是在段落后面使用一个空行来表示重新开始一个段落。

1
2
3
段落1

段落1

字体

Markdown 可以使用以下几种字体:

斜体文本 斜体文本 粗体文本 粗体文本 粗斜体文本 粗斜体文本

1
2
3
4
5
6
*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___

删除线

如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线 ~~

我是删除线

1
2
我是普通文本
~~我要来个删除线~~

分隔线

你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

1
2
3
4
5
***
* * *
*****
- - -
----------

列表

Markdown 支持有序列表和无序列表。
无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格,然后再填写内容:

我的前端技术栈(案例

  • Vue.js 熟练精通
  • React.js 会用
  • node.js 后端开发
1
2
3
4
5
6
7
8
9
10
11
* 第一项
* 第二项
* 第三项

+ 第一项
+ 第二项
+ 第三项

- 第一项
- 第二项
- 第三项

有序列表使用数字并加上 . 号来表示

平凡的一天(案例

  1. 吃饭
  2. 敲代码
  3. 睡觉
1
2
3
1. 第一项
2. 第二项
3. 第三项

列表嵌套

列表嵌套只需在子列表中的选项前面添加四个空格即可:

1
2
3
4
5
6
1. 第一项:
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
2. 第二项:
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素

区块

Markdown 区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号:
区块引用
Markdown教程
今晚不熬夜!!!

上面是区块案例样式

1
2
3
> 区块引用
> Markdown教程
> 今晚不熬夜!!!

另外区块是可以嵌套的,一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推:

1
2
3
> 最外层
> > 第一层嵌套
> > > 第二层嵌套

最外层

第一层嵌套

第二层嵌套


代码

如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如:

printf()函数

1
`printf()` 函数

代码区块

用 ``` 包裹一段代码,并指定一种语言(也可以不指定):

1
2
3
4
5
6
7
\```java
public class demo{
public static void main(String[] args){
System.out.print("今晚不熬夜!");
}
}
\```

案例展示

1
2
3
4
5
public class demo{
public static void main(String[] args){
System.out.print("今晚不熬夜!");
}
}

链接

链接使用方法如下:
百度一下
https://www.baidu.com/

1
2
3
4
5
[名称](网址)

或者

<链接地址>

图片

图片语法格式如下:

1
2
3
![alt 属性文本](图片地址)

![alt 属性文本](图片地址 "可选标题")

小黑子


表格

Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。
语法格式如下:

1
2
3
4
|  表头   | 表头  |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
表头 表头
单元格 单元格
单元格 单元格

对齐方式
我们可以设置表格的对齐方式:

-: 设置内容和标题栏居右对齐。
:- 设置内容和标题栏居左对齐。
:-: 设置内容和标题栏居中对齐。

1
2
3
4
| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
左对齐 右对齐 居中对齐
单元格 单元格 单元格
单元格 单元格 单元格