Markdown语法

发布于 2022-02-03  148 次阅读


Markdown语法


标题

Markdown 标题的两种格式

使用"="与"-"

“=”与“-”放于标题的下一行来表示一、二级标题,“=”与“-”的数量不限

 一级标题
 =======
 二级标题
 -------

使用"#"

使用"#"不同级标题,"#"数量等于标题等级

 # 一级标题
 ## 二级标题
 ### 三级标题
 #### 四级标题
 ##### 五级标题
 ###### 六级标题

字体

粗体&斜体

斜体文本 斜体文本

 *斜体文本*
 _斜体文本_

粗体文本 粗体文本

 **粗体文本**
 __粗体文本__

粗斜体文本 粗斜体文本

 ***粗斜体文本***
 ___粗斜体文本___

分割线

可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西

 ***
 * * *
 *****
 ---
 - - -
 ----------

删除线

前后各加上两个"~",删除线

 ~~删除线~~

下划线

可以使用HTML的标签实现 下划线

 <u>下划线</u>

列表

无序列表

无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格,然后再填写内容

 * 第一项
 * 第二项
 * 第三项
 ​
 + 第一项
 + 第二项
 + 第三项
 ​
 ​
 - 第一项
 - 第二项
 - 第三项

有序列表

有序列表使用数字并加上 . 号来表示

 1. 第一项
 2. 第二项
 3. 第三项

嵌套列表

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

 1. 第一项:
     - 第一项嵌套的第一个元素
     - 第一项嵌套的第二个元素
 2. 第二项:
     - 第二项嵌套的第一个元素
     - 第二项嵌套的第二个元素

区块

区块引用及区块嵌套

区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号,另外区块是可以嵌套的,一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推

 > 区块1
 > 区块2
 ​
 > 最外层
 > > 第一层嵌套
 > > > 第二层嵌套

区块中使用列表

 > 区块中使用列表
 > 1. 第一项
 > 2. 第二项
 > + 第一项
 > + 第二项
 > + 第三项

列表中使用区块

> 前添加四个空格的缩进

 * 第一项
     > 区块1
     > 区块2
 * 第二项

代码

代码片段

如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`

 `printf()` 函数

代码区块

代码区块使用 4 个空格或者一个制表符(Tab 键)

     fmt.Println("Hello World")

也可以用 ``` 包裹一段代码,并指定一种语言(也可以不指定)

 ```markdown
 fmt.Println("Hello World")
 ```

链接

 [链接名称](链接地址)
 ​
 <链接地址>

高级链接

 这个链接用 1 作为网址变量 [Google][1]
 这个链接用 runoob 作为网址变量 [Runoob][runoob]
 然后在文档的结尾为变量赋值(网址)
 ​
  [1]: http://www.google.com/
  [runoob]: http://www.runoob.com/

图片

 ![文本](图片地址)
 ​
 ![文本](图片地址 "可选标题")

可以像网址那样对图片网址使用变量:

 这个链接用 1 作为网址变量 [RUNOOB][1].
 然后在文档的结尾为变量赋值(网址)
 ​
 [1]: p.png

可以用HTML的<img>标签指定图片长宽

 <img src="p.png" width="50%">

表格

Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行

 |  表头   | 表头  |
 | ---- | ---- |
 | 单元格 | 单元格 |
 | 单元格 | 单元格 |

我们可以设置表格的对齐方式:

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

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

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

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

高级技巧

支持的 HTML 元素

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

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

 使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑

转义

Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符:

 **文本加粗** 
 \*\* 正常显示星号 \*\*

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

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

公式

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

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

默认下的分隔符:

  • $...$ 或者 \(...\) 中的数学表达式将会在行内显示。
  • $$...$$ 或者 \[...\] 或者 ```math 中的数学表达式将会在块内显示。
 $$
 \begin{Bmatrix}
    a & b \\
    c & d
 \end{Bmatrix}
 $$
 $$
 \begin{CD}
    A @>a>> B \\
 @VbVV @AAcA \\
    C @= D
 \end{CD}
 $$

笔记源:https://www.runoob.com/markdown/md-tutorial.html


THE END