Markdown语法规则

358 阅读5分钟

1 markdown语法规则

本文跟着菜鸟教程过了一遍markdown教程,教程网址为 Markdown 教程|菜鸟教程

1.1 标题

n个# + 空格 + 题目 :表示第n级标题

1.2 段落格式

markdown段落没有特殊格式,直接写文字。
每一行后面要空2个格子才会重启一行。

1.2.1 字体

* + 文字 + * : 斜体文本
_ + 文字 + _ :斜体文本
** + 文字 + ** :粗体文字
__ + 文字 + __ :粗体文字
*** + 文字 + *** :粗斜体文字
同理: _和*可以组合使用,不过要前后配对。

1.2.2 分割线

在一行中使用三个及以上 * 或 - 或 _ 来进行分割,行内不能有其他东西,可以通过在*号之间插入空格减少*的个数。 如:
* * *


- - -


_ _ _


1.2.3 删除线

~~ + 文字 + ~~ : 删除咯

1.2.4 下划线

<u> + 文字 + </u1> : 确实下划了

这里使用的是HTML的<u>标签实现。
注意后面那个u前面有个 / 表示结束,不然会一直下划。

1.2.5 脚注

脚注用于对文本进行说明。其实有点像引用了。

格式:
对文字进行标注:文字+[^标注的标签] 在后面进行说明:[^标注的标签]:说明文字

说明:
1、这里的“标注的标签”是自己定的,但在默认情况下就和引用一样,他会自动标为[1][2][3]等等,也就会按照出现的先后顺序自动进行编号。
2、无论说明文字的那一段写在哪,都会统一集合在最后面并用分割线与前面的文字进行隔开,还要注意说明文字的" : "必须是英文字符。
3、没有搜到如何修改这种默认情况的方法,好像是由编译器决定的。实锤了,是由编译器决定的,在稀土掘金里面是正常的脚注,vs code的Markdown Preview Enhanced是上面的情况。

示例:
比如我对1.2.4的后面那个<u>标签进行标注,因为是第一个脚注,所以是[1]。 脚注上面的分割线是它自己生成的。

1.3 列表

markdown支持有序无序列表。

1.3.1 无序列表

使用 * 或 + 或 - 这三个符号,但要记得加空格,即:
格式:
* + 空格 + 文字

示例:

  • 第一个
  • 第二个
  • 第三个
  • 第四个
  • 第五个
  • 第六个

说明
可以发现第一个和第二个,第五个和第六个之间的间隔是一样的,比较小,而第三和第四个与前后的间隔较大,因为他们直接用来不同的符号标注的,所以间隔大。

1.3.2 有序列表

有序列表使用数字并加上 . 来表示,即
格式:
数字 + 空格 + .

示例:

  1. 确实
  2. 的确
  3. 也是这样

1.3.3 列表嵌套

列表嵌套只需在子列表中的选项前面添加四个空格(即tab)即可:

  1. 确实
    • 咋滴
    • 就瞅你了
    • 不咋滴
    • 随便你
      1. 参差的世界

1.4 区块

1.4.1 基本区块

格式:
> + 空格 + 文字

示例:

区块引用 这就是区块

可以嵌套哦

类似与标题一样,用多个>即可

1.4.2 列表区块

也就是在列表前先标区块 如:> 1. 就是这样

  1. 就是这样
  1. 确实如此
    • 咋滴了

1.5 代码

1.5.1 基本代码

在段落中的一个函数或者片段代码,使用反引号 ` (在esc下面)把它们包起来。 printf()函数

1.5.2 代码区块

使用三个反引号```前后包裹起来
格式:
``` + 指定语言(也可不指定) 代码 ```

示例:

def main()
    while 1
        x=y
        y = y + 1
        if x > 10
            break

1.6 链接

1.6.1 基本链接

格式:
[链接名称](链接地址) 或 <链接地址>

示例:
百度网址 或 <www.baidu.com>

1.6.2 高级链接

格式:
文字 + [链接名称][链接的标签]

示例:
大家可以点击后面的蓝色的百度二字进入官网

1.7 图片

格式:
![alt 属性文本](图片地址 "可选标题")

  • 开头一个感叹号 !
  • 接着一个方括号,里面放上图片的替代文字
  • 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 'title' 属性的文字。

示例:

![RUNOOB 图标](http://static.runoob.com/images/runoob-logo.png)

![RUNOOB 图标](http://static.runoob.com/images/runoob-logo.png "RUNOOB")

说明: arkdown 还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的 <img> 标签。 如:

<img src="http://static.runoob.com/images/runoob-logo.png" width="50%">

1.8 表格

使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。
格式:
| 表头 | 表头 |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |

示例:

表头表头
单元格单元格
单元格单元格

除此之外,还可以设置对齐方式:
即冒号在哪就那边对齐。

  • -: 设置内容和标题栏居右对齐。
  • :- 设置内容和标题栏居左对齐。
  • :-: 设置内容和标题栏居中对齐。

格式:
| 左对齐 | 居中对齐 | 右对齐 |
| :---- | :----: | ----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |

示例:

左对齐居中对齐右对齐
单元格单元格单元格
单元格单元格单元格

1.9 高级技巧

1.9.1 支持HTML元素

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

目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等

格式: <kbd> + Ctrl + </kbd> 示例: 使用 Ctrl+Alt+Del 重启电脑

1.9.2 转义字符

markdown中的特殊字符需要使用转义符号 \ 才能显示。 比如:\*文字\*,如果不加\,则会显示:文字

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

\ 反斜线
` 反引号
* 星号
_ 下划线
{} 花括号
[] 方括号
() 小括号
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号

1.9.3 公式

Markdown Preview Enhanced 使用 KaTeX 或者 MathJax 来渲染数学表达式。

KaTeX 拥有比 MathJax 更快的性能,但是它却少了很多 MathJax 拥有的特性。你可以查看 KaTeX supported functions/symbols 来了解 KaTeX 支持那些符号和函数。

默认下的分隔符:

$...$ 或者 \(...\) 中的数学表达式将会在行内显示。
$$...$$ 或者 \[...\] 或者 ```math 中的数学表达式将会在块内显示。

Footnotes

  1. 注意这个u前面有个 / 表示结束,不然会一直下划。