用好Markdown,像高手写代码一样自动生成漂亮文档,还很简单

一、什么是markdown

markdown

是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。就连文字排版、画图、等等都像打字一样输入即可自动生成,非常高效。

目前有很多主流文本应用都支持markdown编辑,比如:GitHub,简书,印象笔记,sourceforge等等。下面示例语法都用印象笔记为例。

二、markdown编辑文本

编辑文本是我们写文档最常用的功能,而编辑文本中,打字什么的所有软件都是一样的,没有多大区别。效率区别最大的就是文档样式排版。下面我们就看看markdown语言,如何像打字一样排版。

1、标题

要写标题,用markdown标记,只需要一个# 后面加上文字即可。

语法示例:

以此类推,多少个#号,就是多少级标题。是不是非常的简单。

注意:不同的软件支持可能会有细微差别,有的需要在#号后加空格。

2、文字格式

我们编辑文档最常用到的文字处理就是:加粗、斜体、粗体加斜体,下划线,删除线等等,现在我们来看看用markdown如何简单编辑。

**这是加粗字体**,

*这是斜体*,

***这是粗体加斜体***

这是带下划线的

~~这是带删除线~~

分割线输入---即可

文档缩进,按tab键即可,换行按回车即可。

很简单吧,只需要几个标记就可以了。

3、引用内容

:文字引用

我们写文档,有时候需要引用外部文字。要表示文字是引用的,只需要加上>即可。

语法示例:

>一级引用内容

>>二级引用内容

>>>三级引用内容

效果如下:

如果需要为文字添加链接,只需要将文字用[ ]框起来,并跟在在后面输入URL,用()括起来。

语法示例:[百度](baidu.com)

:图片引用

引用网络图片,只需要输入图片URL即可。

语法示例:

![image](URL)

:代码引用

如果需要引用代码块,则需要将代码段落用 ``` ```符号括起来。

语法示例:

```python

代码块

```

4、列表项

列表项仅仅需要和我们日常习惯一样,输入*号,1.符号,等标记符号即可。

*号代表实心圆点,通常是无序列表。1.就是带数字的有序列表

5、数学公式

数学公式我们引用代码 math。常用上标、下标、分数我们看一下示例

语法示例:

```math

e^ + 1 = 0

```

```math

\frac=\frac+1}+\frac+1}

```

效果如下:

三、画图

文档编辑过程中,画图是很常见的。尤其是画个流程图、时序图、甘特图。画图都是用代码形式输入的,所以,都是以代码块形式来输入。画图引用的是mermai代码模块。

下面我们就逐个看一下样例

1、流程图

graph 是指画流程图,TD表示竖版,LR表示横版双括号(( ))表示圆圈; [ ]表示圆角矩形; / /表示菱形-->表示箭头连接线语法样例:

```mermaid

graph TD

o((开始))-->A[模块A]

A -->|A1| B(模块B)

A-->|a2|G(模块b1)

C -->|条件C1| D[模块D]

C -->|条件C2| E[模块E]

C -->|条件C3| F[模块F]

H-->|tt1|I[tt1]

H-->|tt2|J[tt2]

H-->|tt3|K[tt3]

D-->Z((end))

E-->Z((end))

F-->Z((end))

I-->Z((end))

J-->Z((end))

K-->Z((end))

```

自动生成的竖版效果如下:

自动生成的横版效果如下:

2、时序图

sequenceDiagram 表示时序图

语法示例:

```mermaid

sequenceDiagram

电脑A->>电脑B: SYN:seq=x

电脑B-->>电脑A: ACK+SYN:ack=x+1,seq=y

电脑A->>电脑B: ACK:ack=y+1,seq=x+1

```

效果示例:

3、甘特图

gantt表示甘特图

语法示例:

```mermaid

gantt

title 甘特图

dateFormat YYYY-MM-DD

section 项目A

任务1 :a1, 2019-07-01, 15d

任务2 :a2, after a1, 20d

任务3 :a3, 2019-07-20, 20d

任务4 :a4, after a3, 10d

任务5 :a5, after a4, 15d

```

效果示例:

四、表格

类似于插入excel表格。

语法示例:

| 月份 |潜在机会 |立项阶段 |方案阶段 |招投标阶段 |签单成交 |

| --- | --- | --- | --- | --- | --- |

| 1月 | 520 | 100 |56 |25 | 18 |

| 2月 | 480 | 82 | 30 | 8 | 5 |

| 3月 | 550 | 95 | 48 | 12 |12 |

| 4月 | 610 | 112 | 65 | 33 | 21 |

| 5月 | 880 | 320 | 78 | 52 | 35 |

效果示例:

五、图表

语法示例:

```chart

月份,预算,签单,毛利,净利

6月,50000,48000,20000,10000

7月,30000,21000,14000,8000

8月,50000,47000,26000,23000

9月,70000,62000,33000,21000

10月,60000,55000,34000,20000

11月,40000,35000,19000,16000

type: line

title: 月度业绩表

x.title: 月份

y.title: 金额

y.suffix: ¥

```

效果示例:

type可以选择不同的图表,line表示曲线图,pie表示饼图,bar表示柱状图,radar表示雷达图。

综述

综上所述,我们可以看到,用markdown编写编辑文档,可以非常快速方便的编写文字、图形、表格。

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20191029A031M200?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。

扫码关注云+社区

领取腾讯云代金券

年度创作总结 领取年终奖励