Zexian Li

常用Markdown语法

2018-07-04 · 6 min read

1.文字排版

在文字之前加上 # / ## / ### / #### 表明一级至四级标题.#和文字之间需留有空格.
例如：# 二级标题
换行时.需要在行末键入至少两个空格再按回车.

2.区块

在文字当行开头加上 > 符号.即为区块显示格式. > 和文字之间需留有空格.
例如：> 示例文字 区块格式显示
效果如下：

示例文字 区块格式显示

二级引用和三级引用可以在行开头加上 >> / >>> 来实现，需要注意的是，从较低级引用(eg2)回退到较高级引用(eg1)时需以空行加以区分。

3.强调显示

以*或_包裹的形式，将字段转成斜体以完成强调.
例如：*a* _b_
效果如下：
a b
以**或__包裹的形式，将字段转成粗体以完成强调.
例如：**a** __b__
效果如下：
a b
注：在编写文档的时候利用了反斜杠"\"从而显示相应的*和_符号.其余特殊符号同理.

4.代码显示

行文中短暂的函数/代码可以用反引号(`)将其名字包起来.
例如：为了输出结果，我们使用`print`函数.
效果如下：为了输出结果，我们使用print函数.
为了显示代码区块，可以用三个反引号(```)包裹一段代码来完成显示。(可指定代码语言以实现对应高亮)
例如：
'''Python
import numpy as np
a = [i for i in range(10)]
a = np.array(a)
'''
效果如下：

import numpy as np
a = [i for i in range(10)]
a = np.array(a)

注：有些Markdown支持使用'Tab'或者四个空格完成代码区块的定义.

5.分隔线

利用三个以上的* - _(星号/减号/下划线)建立分隔线.
例如：***
效果如下：

6.列表

无序列表需要利用星号/加号/减号做列表标记.符号后与文字中加一空格.
例如：
* first item
- second item
+ third item
效果如下：

  • first item
  • second item
  • third item
    有序列表在行开头输入数字序号 + '. '即可实现(注意'.'后有一个空格)
    例如：
  1. first item
  2. second item

效果如下：

  1. first item
  2. second item

7.链接

链接可以通过行内链接和参考式链接两种方式实现，其效果相同，但行内链接需要实时填写链接内容，参考式链接可以最后集中输入链接内容，各有利弊，顺势取舍。
(1)行内链接
链接的显示格式为:[显示文字](https_address).
例如：欢迎来到我的[个人博客](https://FuNian788.github.io/).
效果如下:
欢迎来到我的个人博客.
(2)参考式链接
链接的显示格式为:[显示文字][链接序号]，在后文(至少隔一个空行处)以如下格式补充链接:[链接序号]:(https_address).
例如：
欢迎来到我的[个人博客][1]

[1]:https://FuNian788.github.io/
效果如下：
欢迎来到我的个人博客

8.添加图片

图片插入的格式为: ![图片描述](图片链接)
以README.md关联图片的图片地址为例(此处需要将地址中的blob改成raw)：
https://github.com/用户名/仓库名/raw/分支名/图片文件夹名/1.jpg
实际测试时发现不行 地址可如下更改：地址中的blob不变 在图片链接最后加上?raw=true
https://github.com/FuNian788/Git-Usage/blob/master/img/1.jpg?raw=true
为了更改图片的尺寸 可以如下设置
><div align=center><img width="200" height="200" src="https://github.com/FuNian788/Deecamp32/raw/master/img/CloseAreaDetect/source.jpg"/></div>
Gridea支持图片尺寸定义，但不支持缩放：
![图片描述](file:///Users/1.png =WidthxHeight)

9.编写注释

如果想在Markdown正文中保留一部分内容仅供编写者查看，可以使用以下几种方式：
感谢CandyBullet的博文提供思路。
(1)基于隐藏html标签实现

<div style='display: none'>
注释内容1
注释内容2
</div>

(2)基于html注释实现(单/多行注释均可)

<!--注释-->

<!--
注释1
注释2
-->

(3)基于Markdown解析原理实现

[comment]: <> (注释)
[comment]: <> (注释)
[comment]: <> (注释)
[//]: <> (注释)
[//]: # (注释)
[^_^]: # (注释)

10.编写目录

现在绝大多数博客类网站均支持按照标题级别一键生成目录。
目录生成的格式为：

@[TOC]

效果如本文开头所示。

11.删除线

删除线需利用~~包围要删除的内容.
例如：
~~删除文字~~
效果如下：
删除文字

12.注脚

注脚需利用[^footer]格式表示，效果类似论文中的文献引用.
例如：
注脚测试[^1].
[^1]: success!
效果如下：
注脚测试[1].

13.页面内跳转

页面内跳转需使用html代码设置锚以实现.
以跳转到第7条(链接)为例：
(已经在7条编写时内嵌)<span id = "1">链接</span>
(在想要跳转的地方输入)[跳转至'链接'](#1)
效果如下：
跳转至'链接'

14.表格

使用横线'-'、竖线'|'和冒号':'构建表格.
元素间以'|'分割，在第二行以如下四种方式定义表格分布方式：
--:为右对齐，:--为左对齐，:--:为居中对齐，--为默认居中对齐(以上四种中横线的数目没有要求)。
表格编写时对空格数目无要求，可自定义空格数量以便于检查。
例如：
| 排名 | 姓名 | 得分 | 备注 |
| :-- | :---: | ---: | --- |
| 1 | A | 100 | full mask |
| 2 | B | 99 | |
效果如下：

排名 姓名 得分 备注
1 A 100 full mask
2 B 99

15.公式编辑

内容过于繁杂，可参照如下博客.

  1. success! ↩︎

Bad decisions make good stories.