MarkDown使用指南

MarkDown使用指南

1MarkDown简介

• Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档。

• Markdown 语言在 2004 由约翰·格鲁伯（英语：John Gruber）创建。

• Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。

• Markdown 编写的文档后缀为 .md, .markdown。

参考网站：https://www.runoob.com/markdown/md-tutorial.html

2. MarkDown编辑器

有很多编辑器可以用来书写MarkDown，比如我们常用的VSCode代码编辑器，安装了支持MarkDown的插件就可以用来书写MarkDown文档。

常用的MarkDown编辑器

• Typora

• vscode

本人经常使用 Typora

下载地址： https://typora.io/

支持MacOS,Windows和Linux三个平台。

3. MarkDown基本语法

1.标题

# H1## H2### H3#### H4##### H5###### H6

H1

H2

H3

H4

H5

H6

2. 文字强调

粗体

**粗体字**

斜体字

*斜体字*

粗体+斜体

***粗体+斜体***

==高亮==

==高亮==

Typora高亮设置步骤:文件 -> 偏好设置（Ctrl+，）,Markdown -> Markdown扩展语法 -> 勾选高亮，重启Typora，达到高亮效果

3. 列表

有序列表

有序列表的格式是:  数字小数点+空格+文本

1. 有序列表

2. 有序列表

3. 有序列表

1. abc2. bbc3. ccc

无序列表

格式: 横线(星号) + 空格 + 文本

* abc* bbc* ccc

• abc

• bbc

• ccc

不管是有序还是无序都支持嵌套和多级列表：

• abc

• bbc

• ccc

• 姓名

1. 张飞

2. 关羽

4. 链接

格式：方括号小括号(链接)

百度

  [百度](http://www.baidu.com)

5. 图片

格式：感叹号+外部链接的格式。 链接支持相对引用！

  ![百度](https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png)

6. 水平分割线

格式: 空行 —-

---

hello---world

7. 引用

引用其他文字段落的使用

格式： 大于号(>) + 空格 + 内容

> 引用其他文字段落的使用

8. 代码

行内代码

格式：反引号+内容+反引号

System.out.println("hello world");

多行代码

格式：三个反引号+内容+三个反引号

public static void main(String[] args) {}

9. 表格

默认的列左对齐,也支持设置居中和右对齐, 横杆大于等于3， 列的竖必须闭合才能代表一列！

• 默认对齐(左对齐) : :----

• 居中对齐 : :---:

• 右对齐: ---:

姓名	年龄	地址
张飞	20	北京市

| 姓名 | 年龄 |   地址 || :--- | :---: | ---: || 张飞 |   20 | 北京市 |

10. 任务列表

展示待办事项效果, 可以认为是列表的变种，可以混合使用

• - [ ] text : 方括号内部空格代指是待办事项

• - [x] text : 方括号内部 x代指事项已经完成

• [x] 学习java

• 学习前端

- [x] 学习java- [ ] 学习前端

11. 脚注

格式：

• 声明: [^text]: description

• 引用: hello[^text]

版本号：^v1

12. 删除线

格式：两个波浪线+文本+波浪线

删除的内容

~~删除的内容~~

13显示目录结构

[TOC] 目录结构

@[toc]

14其他功能

MarkDown支持html语法

<p style="color:red">段落文字</p>

<div>这是一个div</div>