markdown基础-CFANZ编程社区

Markdown简介

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

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

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

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

编辑器

当前使用较多的编辑器是 Typora，下载：

方式一：官网

标题

使用#号标记

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

注：#号与文字之间至少需要一个空格

段落

Markdown 段落没有特殊的格式，直接编写文字就好，在Typora编辑器中可以设置默认行缩进4个空格，具体操作为：

文件->偏好设置->编辑器->默认缩进，选择4即可

文件->偏好设置->通用->可以设置自动保存

字体

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

hello、hello、hello

分隔线

---
用三个以上的减号来建立一个分隔线，行内不能有其他东西,然后回车即可

删除线

~hello~
在文字的两端加上两个波浪线 ~~ 即可

hello

下划线

下划线可以通过 HTML 的 <u> 标签来实现
<u>带下划线文本</u>

hello

脚注

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

描述[^脚注]


在文末添加脚注：
[^脚注]: 说明

这是一个说明¹

列表

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

无序列表使用减号 - 后面添加空格即可
- 文本

第二层列表，则在第一层的下一行缩进4个空格(Tab键)即可
- 文本
  - 第二层文本

hello

world

有序列表：

使用数字并加上 . 号来表示
1. 文本

hello

world

hello world
hello world

区块、引用

> 引用文本

嵌套
> 文本
>> 第二层
>>> 第三层

hello world

代码块

用反引号把它包起来（`）
行中使用一个反引号
`helloworld`
一段使用三个反引号,然后写语言，比如python代码块
```python
print('hello world')
```

hello world

print('hello world')

链接

[描述](链接地址)

图书管理系统

高级链接：

通过变量来设置一个链接，在文档末尾给变量赋值

图书管理系统

图片

![alt 属性文本](图片地址 “可选标题”)

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-D2SeMtpO-1607569794118)(图片地址)]

表格

|表头|表头| 然后回车键即可

表头	表头

HTML元素

不在 Markdown 涵盖范围之内的标签，都可以直接在文档里面用 HTML 撰写。

目前支持的 HTML 元素有：<kbd> 等，如：

helloworld

转义

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

*斜体*
\*

hello world

*hello world*

公式

当你需要在编辑器中插入数学公式时，可以使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式。

$$ 按回车键即可

KaTeX parse error: Can't use function '$' in math mode at position 249: … \end{vmatrix} $̲{$tep1}{\style{…

$$
公式
$$

a = a + b a = a+ b a=a+b

横向流程图

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

a=1 a=2 方形圆角条件a 结果1 结果2 横向流程图

竖向流程图

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

a=1 a=2 方形圆角条件a 结果1 结果2 竖向流程图

标准流程图

```mermaid
flowchat
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op
```

Created with Raphaël 2.2.0 开始框处理框判断框(是或否?) 输入输出框结束框子流程 yes no

标准流程图（横向）

```mermaid
flowchat
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
```

Created with Raphaël 2.2.0 开始框处理框判断框(是或否?) 输入输出框结束框子流程 yes no

UML时序图

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

对象A 对象B 对象B你好吗?（请求）对象B的描述对象A的描述(提示) 我很好(响应) 你真的好吗？对象A 对象B 标题：复杂使用

UML时序图源码复杂样例

```mermaid
sequenceDiagram
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: 没人陪我玩
```

对象A 对象B 小三 C 对象B你好吗?（请求）对象B的描述对象A的描述(提示) 我很好(响应) 你好吗对象B找我了你真的好吗？我们是朋友没人陪我玩对象A 对象B 小三 C 标题：复杂使用

时序图

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

张三李四王五王五你好吗？与疾病战斗 loop [健康检查] 合理食物看医生... 很好! 你怎么样? 很好! 张三李四王五标题：复杂使用

甘特图

```mermaid
    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
    ```