markdown语法

目录:

一、标题
二、字体
三、引用
四、分割线
五、图片
六、超链接
七、列表
八、表格
九、代码
十、流程图
十一、目录链接

一、标题

“# “+文字,注意#后面有空格
一个#为一级标题,两个#二级标题,支持六级标题
示例:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

二、字体

  • 加粗
    左右各用两个*包起
  • 斜体
    左右各用一个*包起
  • 斜体加粗
    左右各用三个*包起
  • 删除线
    左右各用两个~包起
    示例:
    这是加粗
    这是倾斜
    这是倾斜加粗
    这是删除线

三、引用

引用前面加>即可
示例:

引用

引用中的引用

四、分割线

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

示例:




五、图片

语法: ![图片下文字](地址 “鼠标移动到图片上面显示文字”)
示例:
贝塞尔曲线
图片可以放在github仓库专门的文件夹底下

六、超链接

超链接与图片语法相似,少了个!
[显示的文字](地址 “title”)
示例:
好友的仓库

七、列表

无序列表

用- + * 任意一个加上空格加文字
如:

  • 列表
  • 列表
  • 列表

    有序列表

    用数字加.加空格加文字
    如:
  1. 列表
  2. 列表
  3. 列表

    列表嵌套

    下一级前面敲三个空格
    如:
  4. 列表
    • 子列表
    • 子列表
      • 孙列表
  5. 列表
    1. 子列表
    2. 子列表
      1. 孙列表
      2. 孙列表

八、表格

语法:(因为这一行没空,所以不显示表格)
|表头1 | 表头2 | 表头3|
|— | :—: | —:|
|1 | 2 | 3|
|4 | 5 | 6|
|7 | 8 | 9|

示例:

表头1 表头2 表头3
1 2 3
4 5 6
7 8 9
注意事项:
1. 表头上一行要置空
2. -至少要三个
3. :用来决定右对齐、居中对齐,默认左对齐

九、代码

单行代码用反引号`包起来,
如:int x = 1;
多行代码用三个反引号<!–0–>

在前三个反引号后面还可以加上语言种类,如java

十、流程图

目前github不支持流程图,需要自己加载插件,很麻烦

1
2
3
4
5
6
7
8
st => start: start
op1 => operation: op
cond => condition: sure?
e => end: end

st -> op1 -> cond
cond(yes, right) -> op1
cond(no) -> e
graph TB A --> B; B --> C; C --> D;

参考高鸿祥:Markdown基本语法

十一、目录链接

1
2
//将目录放在span中,并生命id
## <span id="11">十一、目录连接</span>

在目录处使用和链接类似语法

1
2
//[目录名称](#span_id)
[十一、目录链接](#11)

这种用法不一定是目录,下面的【回到顶部】也是这种用法

回到顶部