速成MarkDown
发表于：2023-06-30 | 分类： 工具
字数统计: 2.7k | 阅读时长: 10分钟 | 阅读量：

关于Markdown

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

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

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

Markdown应用

  • Markdown 能被使用来撰写电子书，如：Gitbook。

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

方式一：使用 = 和 - 标记一级和二级标题
=和-的个数任意

标题格式

方式一：

1
2
3
4
我是一级标题
===
我是二级标题
---

方式二：使用 # 号标记
使用 # 号可表示 1-6 级标题

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

段落格式

在段落后面使用一个空行来表示重新开始一个段落。
示例1

示例2

字体

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

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

效果：
斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本

分割线

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

1
2
3
4
5
6
7
8
9
***

* * *

*****

- - -

----------

效果：

删除线

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

例子

文字前面两个 ~~ 表示删除线起点，后面两个表示终点

下划线

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

示例

< u >表示开始，< /u >表示结束

脚注

脚注是对文本的补充说明。

Markdown 脚注的格式如下:

1
2
[^要注明的文本]
[^文本1]:内容1

创建脚注格式类似这样 ^文本1。

角标会自动叠加^文本2

注意：脚注的:必须是英文格式下的

如果后续文本不是标题，便会出现在脚注区域

开新段落后不受影响；标题后续的文字不受影响

列表

Markdown 支持有序列表和无序列表。

无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记，这些标记后面要添加一个空格，然后再填写内容：

1
2
3
* 第一项
+ 第二项
- 第三项

效果：

  • 第一项

  • 第二项

  • 第三项

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

  1. 示例一
  2. 示例二

.后面要加空格，否则：
1.示例一
2.示例二

列表嵌套

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

  1. 第一项（列表前至少需要三个空格）：
    • 第一项嵌套的第一个元素
    • 第一项嵌套的第二个元素
  • 第二项（列表前至少需要两个空格）：
    1. 第二项嵌套的第一个元素
    2. 第二项嵌套的第二个元素

区块

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

区块引用

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

最外层

第一层嵌套

第二层嵌套

区块中使用列表

区块中使用列表实例如下：
fa017d90f5439af63bb3589e7f6cd43a.png
效果：

区块中使用列表

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

列表中使用区块

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

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

  • 第一项

    内容

  • 第二项

代码

如果是段落上的一个函数或片段的代码可以用反引号把它包起来（`），例如：

printf() 函数
反引号 ` 即英文模式下的 ~ 键

代码区块

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

1
2
3
4
5
6
//下面的/代表转义，使用时去掉
\```java
public calss A{
    
    }
\```

效果：

1
2
3
public calss A{
    
    }

链接

使用方法如下：
[链接名称](链接地址)
或者
<链接地址>

例如：
这是一个链接 百度
或者
https://www.baidu.com

高级链接

我们可以通过变量来设置一个链接，变量赋值在文档末尾进行：
使用方法：[][]
有点类似脚注，第二个[]中为网址变量

1
2
3
4
[百度][1]
[百度][百度]
[1]: http://www.baidu.com/
[百度]: http://www.baidu.com/

示例：
这个链接用 1 作为网址变量 百度
这个链接用 百度 作为网址变量 百度
然后在文档的结尾为变量赋值（网址）

图片

Markdown 图片语法格式如下：

  • 开头一个感叹号 !
  • 接着一个方括号，里面放上图片的替代文字
  • 接着一个普通括号，里面放上图片的网址，最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字。

效果：

1
![测试](https://images.wallpaperscraft.com/image/single/starry_sky_boat_reflection_125803_1920x1080.jpg "可选标题")

测试

地址不对：

测试

当然，也可以像网址那样对图片网址使用变量:

1
2
[示例][图片]
[图片]: https://images.wallpaperscraft.com/image/single/starry_sky_boat_reflection_125803_1920x1080.jpg

在文档的结尾为变量赋值（网址）

示例

Markdown 还没有办法指定图片的高度与宽度，如果需要的话，你可以使用普通的 < img > 标签。

表格

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

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

效果：

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

对齐方式

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

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

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

效果：

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

高级技巧

标签

支持的 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 支持以下这些符号前面加上反斜杠来帮助插入普通的符号：

1
2
3
4
5
6
7
8
9
10
11
12
\ 反斜线
` 反引号
\* 星号
_ 下划线
{} 花括号
\[\] 方括号
() 小括号
\# 井字号
\+ 加号
\- 减号
. 英文句点
! 感叹号

公式

Markdown Preview Enhanced 使用 KaTeX 或者 MathJax 来渲染数学表达式。KaTeX 拥有比 MathJax 更快的性能，但是它却少了很多 MathJax 拥有的特性。
你可以查看 KaTeX supported functions/symbols 来了解 KaTeX 支持那些符号和函数。

默认下的分隔符：

$...$ 或者 \(...\) 中的数学表达式将会在行内显示。$$...$$ 或者 \[...\] 或者 ```math 中的数学表达式将会在块内显示。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
#直接写就行，不需要代码块

$f(x)=2x+8$

$$
\begin{Bmatrix}
   a & b \\
   c & d
\end{Bmatrix}
$$
$$
\begin{CD}
   A @>a>> B \\
@VbVV @AAcA \\
   C @= D
\end{CD}
$$

效果：

$f(x)=2x+8$

$$
\begin{Bmatrix}
a & b \
c & d
\end{Bmatrix}
$$
$$
\begin{CD}
A @>a>> B \
@VbVV @AAcA \
C @= D
\end{CD}
$$

几个实例效果图如下：

1、横向流程图源码格式：

1
2
3
4
5
6
graph LR
A[方形] -->B(圆角)
    B --> C{条件a}
    C -->|a=1| D[结果1]
    C -->|a=2| E[结果2]
    F[横向流程图]

2、竖向流程图源码格式：

1
2
3
4
5
6
graph TD
A[方形] --> B(圆角)
    B --> C{条件a}
    C --> |a=1| D[结果1]
    C --> |a=2| E[结果2]
    F[竖向流程图]

3、标准流程图源码格式：

1
2
3
4
5
6
7
8
9
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op

4、标准流程图源码格式（横向）：

1
2
3
4
5
6
7
8
9
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st(right)->op(right)->cond
cond(yes)->io(bottom)->e
cond(no)->sub1(right)->op

5、UML时序图源码样例：

1
2
3
4
5
对象A->对象B: 对象B你好吗?（请求）
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象A->对象B: 你真的好吗？

6、UML时序图源码复杂样例：

1
2
3
4
5
6
7
8
9
10
11
Title: 标题：复杂使用
对象A->对象B: 对象B你好吗?（请求）
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象B->小三: 你好吗
小三-->>对象A: 对象B找我了
对象A->对象B: 你真的好吗？
Note over 小三,对象B: 我们是朋友
participant C
Note right of C: 没人陪我玩

7、UML标准时序图样例：

1
2
3
4
5
6
7
8
9
10
11
12
%% 时序图例子,-> 直线，-->虚线，->>实线箭头
  sequenceDiagram
    participant 张三
    participant 李四
    张三->王五: 王五你好吗？
    loop 健康检查
        王五->王五: 与疾病战斗
    end
    Note right of 王五: 合理 食物 <br/>看医生...
    李四-->>张三: 很好!
    王五->李四: 你怎么样?
    李四-->王五: 很好!

8、甘特图样例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
%% 语法示例
        gantt
        dateFormat  YYYY-MM-DD
        title 软件开发甘特图
        section 设计
        需求                      :done,    des1, 2014-01-06,2014-01-08
        原型                      :active,  des2, 2014-01-09, 3d
        UI设计                     :         des3, after des2, 5d
    未来任务                     :         des4, after des3, 5d
        section 开发
        学习准备理解需求                      :crit, done, 2014-01-06,24h
        设计框架                             :crit, done, after des2, 2d
        开发                                 :crit, active, 3d
        未来任务                              :crit, 5d
        耍                                   :2d
        section 测试
        功能测试                              :active, a1, after des3, 3d
        压力测试                               :after a1  , 20h
        测试报告                               : 48h
MarkDown
上一篇:
Nginx

    • 欢迎访问本小站