一些记录...

Lying awake and worrying about the day ahead.

0%

Markdown使用教程

Markdown简介

Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber)。允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的HTML文档。文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。文档后缀为 .md, .markdown。

使用Markdown的网站:
国外的GitHub、Reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等;
国内的CSDN、简书、掘金、博客园、知乎等。

Markdown基本语法

标题

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

注意事项:

  • 最后一个#字符与标题中间留一个空格
  • 标题应该置于行首,如果放入表格中可能无法正确解析

字体

符号中间空格填写字符

  • * *斜体
  • _ _斜体
  • ** **粗体
  • __ __粗体
  • *** ***粗斜体体
  • ___ ___粗斜体
  • ~~ ~~删除线
  • <u> </u>下划线

换行

  • 两个空格
  • 空行
  • 文字中间加<br/>

引用

通过符号 > 来实现,其后的空格可有可无。
引用之间可以相互嵌套,例如:

1
2
3
> 一级引用
>> 二级引用
>>> 三级引用

一级引用

二级引用

三级引用

通过空行结束引用。

插入链接与图片

链接

1
2
1、[链接名称](链接地址)
2、<链接地址>

图片

图片大小不能控制

1
2
![图片描述,内容可为空](图片地址:本地链接或者URL地址)
例如:![示例图片](../img/favicon.ico)

示例图片

列表

使用Tab键控制列表层级

无序列表

*+- 再加上空格

有序列表

数字加上.号加上空格

分割线

三个-or*来建立一个分割线,分割线上方和下方都需有一空行

代码块

行内代码

1
`code`

多行代码

``` language

code

```

表格

使用|来分割不同单元格,-来分割表头和其他行

  • :-:将表头及单元格内容左对齐
  • -::将表头及单元格内容右对齐
  • :-::将表头及单元格内容居中

示例:

1
2
3
4
5
6
| 项目        | 价格     |  数量  |
| -------- | -----: | :----: |
| 计算机 | \$1600 | 5 |
| 手机 | \$12 | 12 |
| 管线 | \$1 | 234 |

特殊符号

用反斜线\可以显示特殊符号本身

Markdown高级语法

待办事项

1
2
- [ ] 支持以 PDF 格式导出文稿
- [x] 新增 Todo 列表功能
  • [ ] 支持以 PDF 格式导出文稿
  • [x] 新增 Todo 列表功能

书写数学公式

:行内公式

$$$ $$$:整行公式

支持HTML

Markdown支持原生HTML语法,例如表格、字体

1
2
3
4
5
6
7
8
9
10
11
12
13
<table>
<tr>
<th rowspan="2">值班人员</th>
<th>星期一</th>
<th>星期二</th>
<th>星期三</th>
</tr>
<tr>
<td>李强</td>
<td>张明</td>
<td>王平</td>
</tr>
</table>

值班人员 星期一 星期二 星期三
李强 张明 王平

1
<font face="楷体" color=#f00 size=5>文字格式</font>
文字格式

绘制流程图、时序图、甘特图

流程图

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

甘特图

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
%% 语法示例
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
section 测试
功能测试 :active, a1, after des3, 3d
压力测试 :after a1 , 20h
测试报告 : 48h