markdown编辑文档使用教程

最近一直在自学，学习的同时保持输出很重要，用了下markdown输出文档，比较简洁快速，根据网上资料自己实操整理了这篇教程博文。（这篇博文就是markdown输出）

推荐使用 Typora 编辑器 Typora官网

简介

Markdown是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，它可以使普通文本内容具有一定的格式。

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

标题

---

直接输入1个#，并按下space后，将生成1级标题。
输入2个#，并按下space后，将生成2级标题。
以此类推，支持6级标题。

• 语法：

  # 一级标题
  ## 二级标题
  ### 三级标题
  #### 四级标题
  ##### 五级标题
  ###### 六级标题

• 效果：

  一级标题

  二级标题

  三级标题

  四级标题

  五级标题

  六级标题

文本样式

---

字体

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

• 语法：
  *斜体文本*
  _斜体文本_
  ** 粗体文本**
  __ 粗体文本__
  *** 粗斜体文本***
  ___ 粗斜体文本___

• 效果：

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

分隔线

在一行中用三个以上的星号*、减号-、底线_来建立一个分隔线，行内不能有其他东西，可以在星号或是减号中间插入空格。

• 语法：
  ***
  * * *
  *****
  - - -
  ----------
• 效果：

  ---

  ---

  ---

  ---

  ---

删除线

在文字添加删除线，在文字的两端加两个波浪线 ~ ~：

• 语法：
  ~~ 这段文字删除了，不需要~~
• 效果：

  这段文字删除了，不需要

下划线

使用 HTML 的 <u> 标签：

• 语法：
  <u>加上下划线</u>
• 效果：

  加上下划线

注脚

对需要加入注脚解释声明的段落或文字，可以使用 [^要注脚的文字]

• 语法：
  [^1]
  [^1]:注脚的解释内容
• 效果：

  这是被注脚的文本¹

列表

---

列表分为有序列表和无序列表，无序列表使用星号*、加号+或是减号-作为列表标记，有序列表使用数字并加上.

1. 无序列表：

• 语法：
  - 项目1
  * 项目2
  + 项目3
• 效果：

  • 项目1

  • 项目2

  • 项目3

2. 有序列表

• 语法：
  1. 项目1
  2. 项目2
  3. 项目3
• 效果：

  1. 项目1
  2. 项目2
  3. 项目3

3. 列表嵌套
   在列表中再嵌套列表，在子列表中的选项添加四个空格space

• 语法：
  1. 项目1
     1. 嵌套项目1
     2. 嵌套项目2
  2. 项目2
     1. 嵌套项目1
     2. 嵌套项目2
• 效果：

  1. 项目1
     1. 嵌套项目1
     2. 嵌套项目2
  2. 项目2
     1. 嵌套项目1
     2. 嵌套项目2

4. 选框列表
   选框效果列表，未选中使用-[space]，选中使用-[x]

• 语法：
  - [ ] 计划任务
  - [x] 完成任务
• 效果：

  • 选中列表1
  • 选中列表2

区块

---

引用区块的使用>

• 语法：
  > 文字内容
• 效果：

  文字内容

嵌套区块 ：
一个 > 符号是最外层，两个> 符号是第一层嵌套，以此类推：

• 语法：
  > 第一层
  > > 第二层
  > > > 第三层
• 效果：

  第一层

  第二层

  第三层

区块中使用列表:

• 语法：
  > 1. 第一项
  > 2. 第二项
  > + 第一项
  > + 第二项
  > + 第三项
• 效果：

1. 第一项
2. 第二项

• 第一项
• 第二项
• 第三项

列表中使用区块:
如果要在列表项目内放进区块，那么就需要在 > 前添加四个空格的缩进。

• 效果：

• 第一项

  项目1
  项目2

• 第二项

  项目1

代码片

---

文本中的函数或代码片段用反引号`包起来

• 语法：
  `java()` 函数
• 效果：

  java() 函数

代码片：
用```包裹一段代码，并指定一种语言（也可以不指定）

• 语法：
  ```
  if (CollectionUtils.isEmpty(actTaskMap.get(actRuleGroup.getRuleGroupCode()))) {
  return true;
  }
  ```

• 效果：

  if (CollectionUtils.isEmpty(actTaskMap.get(actRuleGroup.getRuleGroupCode()))) {
    	 return true;
   }
  

链接

---

[链接名称](链接地址)
或者
<链接地址>

• 语法：
  名称加地址：[链接名称](链接地址)

  直接使用地址 ：<链接地址>

• 效果：

  名称加地址 ： 百度链接名称
  直接使用地址 ： https://www.baidu.com

高级链接：
通过变量来设置一个链接，变量赋值在文档末尾进行

• 语法：

  用 3 作为网址变量[百度][3]
  用 zhihu 作为网址变量 [知乎][zhihu]
  为变量赋值（网址）

  [3]: https://www.baidu.com/
  [zhihu]: https://www.zhihu.com/

• 效果：

  用 3 作为网址变量百度
  用 zhihu 作为网址变量 知乎
  为变量赋值（网址）

图片

---



• 语法：
  
• 效果：
  

表格

---

表格使用| 来分隔不同的单元格，使用 - 来分隔表头和其他行

• 语法：

  表头1 | 表头2
  -------- | -----
  电脑 | 666
  手机 | 888
  铅笔 | 333

• 效果：

表头1	表头2
电脑	666
手机	888
铅笔	333

表格文本位置控制：

• 语法：

| Column 1 | Column 2|Column 3 |
|:----- | :----: | -----: |
| 文本居左 | 文本居中 | 文本居右 |

• 效果：

Column 1	Column 2	Column 3
文本居左	文本居中	文本居右

其他

---

不在 Markdown 涵盖范围之内的标签，都可以直接在文档里面用 HTML 撰写。
目前支持的 HTML 元素有：<kbd> <b> <i> <em> <sup> <sub> <br>等

转义字符
Markdown 使用了很多特殊符号来表示特定的意义，如果需要显示特定的符号则需要使用转义字符，Markdown 使用反斜杠 \ 转义特殊字符

公式
当你需要在编辑器中插入数学公式时，可以使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。提交后，问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染。如：

$$
\Gamma(z) = \int_0^\infty t^{z-1}e{-t}dt,.
$$

效果：
$$\Gamma (z)={\int }_0^{\infty }{t}^{z-1}{e}^{-t}dt.$$

---

1. 这是一个注脚解释 ↩︎