markdown简单语法

  • 什么是markdown?
    Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。markdown
  • 为什么要使用markdown?
    轻量、优雅、流行不然用txt?

一、标题

在想要设置为标题的文字前面加#来表示(#后要加空格)。一个#是一级标题,二个#是二级标题,以此类推。支持六级标题。

二、字体

  • 斜体
    要倾斜的文字左右分别用一个*号包起来
  • 加粗
    要加粗的文字左右分别用两个*号包起来
  • 斜体加粗
    要倾斜的文字左右分别用三个*号包起来
  • 删除线
    要加删除线的文字左右分别用两个~~号包起来

三、引用

在引用的文字前加>即可。引用也可以嵌套,如加两个>>三个>>>…

四、分割线

三个或者三个以上的 - 或者 * 都可以。

五、图片

![图片alt](图片地址 ‘’图片title’’)
图片alt就是显示在图片下面的文字,相当于对图片内容的解释。
图片title是图片的标题,当鼠标移到图片上时显示的内容。title可加可不加

六、超链接

[超链接名](超链接地址 ‘’超链接title’’)
title可加可不加

七、列表

  • 无序列表
    语法:无序列表用 - + * 任何一种都可以

    1
    2
    3
    4
    5
    - 列表内容
    + 列表内容
    * 列表内容

    注意:- + * 跟内容之间都要有一个空格
  • 有序列表
    数字加点

    1
    2
    3
    1. 列表内容
    2. 列表内容
    注意:序号跟内容之间要有空格,序号会自动更新
  • 列表嵌套
    在父级的基础上,子级在开头加两个空格(1个Tab)即可。

八、表格

1
2
3
4
|表头|表头|表头|
|---|:--:|---:|
|内容|内容|内容|
|内容|内容|内容|
表头 表头 表头
内容 内容 内容
内容 内容 内容

九、代码

单行代码:代码之间分别用一个反引号包起来
代码块:代码之间分别用三个反引号包起来,且两边的反引号单独占一行

十、流程图

flow流程图

流程图编写是最好是顶格写,用tab退格会出现问题不容易移植,特别注意前后空格,否则无法解析

1
2
3
4
5
6
7
8
9
10
```flow
st=>start: 开始
op=>operation: My Operation
cond=>condition: Yes or No?
e=>end

st->op->cond
cond(yes) -> e
cond(no)->op
`` `

mermaid流程图

注意 vscode 支持预览需要插件 如Markdown Preview Mermaid Support

1
2
3
4
5
6
7
``` mermaid
graph LR;
a --> id{b};
id{b} --> c;
c --> id{b};
id{b} --> d;
`` `

流程图方向

  • TB 从上到下
  • BT 从下到上
  • RL 从右到左
  • LR 从左到右
  • TD 同TB 从上到下

基本图形

  • id + [文字描述]矩形
  • id + (文字描述)圆角矩形
  • id + >文字描述]不对称的矩形
  • id + {文字描述}菱形
  • id + ((文字描述))圆形

节点之间的连接

  • A –> B A带箭头指向B
  • A — B A不带箭头指向B
  • A -.- B A用虚线指向B
  • A -.-> B A用带箭头的虚线指向B
  • A ==> B A用加粗的箭头指向B
  • A – 描述 — B A不带箭头指向B并在中间加上文字描述
  • A – 描述 –> B A带箭头指向B并在中间加上文字描述
  • A -. 描述 .-> B A用带箭头的虚线指向B并在中间加上文字描述
  • A == 描述 ==> B A用加粗的箭头指向B并在中间加上文字描述