Markdown 教程

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

Markdown 应用

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


编辑器

本教程将使用 Typora 编辑器来讲解 Markdown 的语法,Typora 支持 MacOS、Windows、Linux 平台,且包含多种主题,编辑后直接渲染出效果。
支持导出HTML、PDF、Word 等多种类型文件。
Typora 官网:https://typora.io/


测试实例

Mardown 编写 Hello World 语法:

# Hello World!

将该代码格式粘贴到 typora 效果如下:

Hello World!


Markdown 标题

Markdown 标题有两种格式。

1、使用 =- 标记一级和二级标题

我展示的是一级标题
================

我展示的是二级标题
----------------

显示效果如下图:

我展示的是一级标题

我展示的是二级标题

2、使用 # 号标记

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

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

显示效果如下图:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

Markdown 段落

Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车。

annum.cn  
annum.cn

当然也可以在段落后面使用一个空行来表示重新开始一个段落。

annum.cn

annum.cn

文字

Markdown 可以使用以下几种字体

*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___

显示效果如下所示:

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

分隔线

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

***

---

显示效果如下所示:



删除线

如果段落上的文字要添加删除线,只需要只文字的两端加上两个波浪线~~即可,实例如下:

oneboke.com
oneboke.com
~~oneboke.com~~

显示效果如下所示:
oneboke.com
oneboke.com
oneboke.com

下划线

下划线可以通过HTML的<u>标签来实现:

<u>带下划线文本</u>

脚注

脚注是对文本的补充说明。
Markdown 脚注的格式如下:

[ ^定义名]: 定义内容;

Markdown 列表

Markdown 支持有序列表和无序列表。
无序列表使用星号(*)、加号(+)或是(-)作为列表标记:

* 第一项
* 第二项
* 第三项

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

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

显示结果如下:

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

有序列表使用数字加上.号来表示,如:

1. 第一项
2. 第二项
3. 第三项

显示结果如下:

  1. 第一项
  2. 第二项
  3. 第三项

列表嵌套

1. 第一项
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素

显示结果如下所示:

  1. 第一项

    • 第一项嵌套的第一个元素
    • 第一项嵌套的第二个元素
  2. 第二项

    • 第二项嵌套的第一个元素
    • 第二项嵌套的第二个元素

Markdown 区块

Markdown 区块引用是在段落开头使用>符号,然后后面紧跟一个空格符号:

> 时光笔记
> 记录时光
> 记录你

显示结果如下:

时光笔记
记录时光
记录你

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

> 最外层
>> 第一层嵌套
>>> 第二层嵌套

显示结果如下:

最外层

第一层嵌套

第二层嵌套

区块中使用列表

区块中使用列表实例如下:

> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项

显示结果如下:

区块中使用列表

  1. 第一项
  2. 第二项
  • 第一项
  • 第二项
  • 第三项

列表中使用区块

如果要再列表项目内放进区块,那么就需要在>前添加两个个空格的缩进。

* 第一项
    > 时光笔记
    > 记录时光记录你
* 第二项

显示结果如下:

  • 第一项

时光笔记
记录时光记录你

  • 第二项

Markdown 代码

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

`printf()`函数

显示结果如下:
printf()函数

代码区块

代码区块使用三个反引号`包裹一段代码,并指定一种语言(也可以不指定):

` ` `javascript
$(document).ready(function () {
    alert('RUNOOB');
});
` ` `

(注:反引号之间没有空格,这里是为了防止被解析导致无法显示,反引号间插入了空格)

显示结果如下:

$(document).ready(function () {
    alert('RUNOOB');
});

Markdown 链接

链接的使用方法如下:

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

例如:

这是一个链接 时光笔记

直接使用链接地址:

<https://annum.cn>

显示结果如下:

https://annum.cn

高级链接

链接也可以用变量来代替,文档末尾附带变量地址:
这个链接用 `1` 作为网址变量 [Google][1]
这个链接用 `annum` 作为网址变量 [Annum][annum]
然后在文档的结尾为变量赋值(网址)

[annum]:https://www.annum.com/

链接也可以用变量来代替,文档末尾附带变量地址:
这个链接用 1 作为网址变量 Google
这个链接用 annum 作为网址变量 Annum
然后在文档的结尾为变量赋值(网址)


Markdown 图片

Markdown 图片语法格式如下:

![alt 属性文本](图片地址)
![alt 属性文本](图片地址 "可选标题")
  • 开头一个感叹号
  • 接着一个方括号,里面放上图片的替代的文字
  • 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的"title"属性的文字。

使用实例:


显示结果如下:

![annum 图标](https://annum.cn/usr/uploads/2018/09/09/1536504365.jpg)
![annum 图标](https://annum.cn/usr/uploads/2018/09/09/1536504365.jpg)

annum 图标
annum 图标

当然,你也可以向网址那样对图片网址使用变量:

这个链接用 1 作为网址变量 [ANNUM][3].
然后在文档的结尾变量赋值(网址)

显示结果如下:

这个链接用 1 作为网址变量 ANNUM.
然后在文档的结尾变量赋值(网址)
Markdown 还没有办法指定图片的高度和款段,如果你需要的话,你可以使用普通的 标签。

<img src="https://annum.cn/usr/uploads/2018/09/09/1536504365.jpg" width="50%">

显示结果如下:


Markdown 表格

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

| 表头 | 表头 |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |

以上代码显示结果如下:

表头表头
单元格单元格
单元格单元格

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

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

实例如下:

| 左对齐 | 右对齐 | 居中对齐 |
|:---- | ----: | :----: |
| 单元格 | 单元格 | 单元格 | 
| 单元格 | 单元格 | 单元格 | 

以上代码显示结果如下:

左对齐右对齐居中对齐
单元格单元格单元格
单元格单元格单元格

Markdown 高级技巧

支持 HTML 元素

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

使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑

输出结果为:

使用 Ctrl+Alt+Del 重启电脑

转义

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

**文本加粗**
\*\*正常显示星号\*\*

输出结果为:
文本加粗
**正常显示星号**

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号

公式

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

$$
\mathbf{V}_1 \times \mathbf{V}_2 =  \begin{vmatrix} 
\mathbf{i} & \mathbf{j} & \mathbf{k} \\
\frac{\partial X}{\partial u} &  \frac{\partial Y}{\partial u} & 0 \\
\frac{\partial X}{\partial v} &  \frac{\partial Y}{\partial v} & 0 \\
\end{vmatrix}
$$tep1}{\style{visibility:hidden}{(x+1)(x+1)}}
$$
Last modification:July 8th, 2020 at 12:32 am
If you think my article is useful to you, please feel free to appreciate