# markdown **Repository Path**: delovery/markdown ## Basic Information - **Project Name**: markdown - **Description**: markdown 语法 - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2023-02-22 - **Last Updated**: 2023-05-27 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README [TOC] # Markdown 标题 Markdown 标题有两种格式。 ## 1、使用 = 和 - 标记一级和二级标题 = 和 - 标记语法格式如下： ```markdown 我展示的是一级标题 ================= 我展示的是二级标题 ----------------- ``` ## 2、使用 # 号标记 使用 # 号可表示 1-6 级标题，一级标题对应一个 # 号，二级标题对应两个 # 号，以此类推。 ```markdown # 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题 ``` # Markdown 段落 ## 1、换行 Markdown 段落没有特殊的格式，直接编写文字就好，段落的换行是使用两个以上空格加上回车。 当然也可以在段落后面使用一个空行来表示重新开始一个段落。 ## 2、字体 Markdown 可以使用以下几种字体： ```markdown *斜体文本* _斜体文本_ **粗体文本** __粗体文本__ ***粗斜体文本*** ___粗斜体文本___ ``` ## 3、分隔线 可以在一行中用三个以上的星号、减号、底线来建立一个分隔线，行内不能有其他东西。 也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线： ```markdown *** * * * ***** - - - ---------- ``` ## 4、删除线 如果段落上的文字要添加删除线，只需要在文字的两端加上两个波浪线 `~~` 即可，实例如下： ```markdown RUNOOB.COM GOOGLE.COM ~~BAIDU.COM~~ ``` ## 5、下划线 下划线可以通过 HTML 的 `` 标签来实现： ```html 带下划线文本 ``` ## 6、脚注 脚注是对文本的补充说明。 Markdown 脚注的格式如下: ```markdown [^要注明的文本] ``` 例如: 创建脚注格式类似这样 [^RUNOOB]。 [^RUNOOB]: 菜鸟教程 -- 学的不仅是技术，更是梦想！！！ # Markdown 列表 Markdown 支持有序列表和无序列表。 ## 1、无序列表 使用星号(*)、加号(+)或是减号(-)作为列表标记，这些标记后面要添加一个空格，然后再填写内容： ```markdown * 第一项 * 第二项 * 第三项 + 第一项 + 第二项 + 第三项 - 第一项 - 第二项 - 第三项 ``` ## 2、有序列表 使用数字并加上 . 号来表示，如： ```markdown 1. 第一项 2. 第二项 3. 第三项 ``` ## 3、列表嵌套 列表嵌套只需在子列表中的选项前面添加两个或四个空格即可： ```markdown 1. 第一项： - 第一项嵌套的第一个元素 - 第一项嵌套的第二个元素 2. 第二项： - 第二项嵌套的第一个元素 - 第二项嵌套的第二个元素 ``` # Markdown 区块 ## 1、基本使用 Markdown 区块引用是在段落开头使用 > 符号 ，然后后面紧跟一个空格符号： ```markdown > 区块引用 > 菜鸟教程 > 学的不仅是技术更是梦想 ``` ## 2、嵌套使用 一个 > 符号是最外层，两个 > 符号是第一层嵌套，以此类推： ```makrkdown > 最外层 > > 第一层嵌套 > > > 第二层嵌套 ``` ## 3、区块中使用列表 区块中使用列表实例如下： ```markdown > 区块中使用列表 > 1. 第一项 > 2. 第二项 > + 第一项 > + 第二项 > + 第三项 ``` ## 4、列表中使用区块 如果要在列表项目内放进区块，那么就需要在 > 前添加四个空格的缩进。 列表中使用区块实例如下： ```markdown * 第一项 > 菜鸟教程 > 学的不仅是技术更是梦想 * 第二项 ``` # Markdown 代码 ## 1、代码片段 如果是段落上的一个函数或片段的代码可以用反引号把它包起来（\`），例如： ```markdown `printf()` 函数 ``` ## 2、代码区块 代码区块使用 4 个空格或者一个制表符（Tab 键） 或者使用 \`\`\` 包裹一段代码，并指定一种语言（也可以不指定）： ```javascript $(document).ready(function () { alert('RUNOOB'); }); ``` # Markdown 链接 ## 1、简单链接 \[链接名称\]\(链接地址\) 或者 \<链接地址\> ```markdown 这是一个链接 [菜鸟教程](https://www.runoob.com) ``` ## 2、高级链接 可以通过变量来设置一个链接，变量赋值在文档末尾进行： ```markdown 这个链接用 1 作为网址变量 [Google][1] 这个链接用 runoob 作为网址变量 [Runoob][runoob] 然后在文档的结尾为变量赋值（网址） [1]: http://www.google.com/ [runoob]: http://www.runoob.com/ ``` # Markdown 图片 ## 1、简单链接 \!\[alt 属性文本\]\(图片地址\) \!\[alt 属性文本\]\(图片地址 "可选标题"\) 开头一个感叹号 ! 接着一个方括号，里面放上图片的替代文字 接着一个普通括号，里面放上图片的网址，最后还可以用引号包住并加上选择性的 'title' 属性的文字。 使用实例： ```markdown ![RUNOOB 图标](http://static.runoob.com/images/runoob-logo.png) ![RUNOOB 图标](http://static.runoob.com/images/runoob-logo.png "RUNOOB") ``` ## 2、高级链接 可以像网址那样对图片网址使用变量: ```markdown 这个链接用 1 作为网址变量 [RUNOOB][1]. 然后在文档的结尾为变量赋值（网址） [1]: http://static.runoob.com/images/runoob-logo.png ``` ## 3、img标签 Markdown 还没有办法指定图片的高度与宽度，如果你需要的话，你可以使用普通的 \ 标签。 ```html ``` # Markdown 表格 Markdown 制作表格使用 `|` 来分隔不同的单元格，使用 `-` 来分隔表头和其他行。 语法格式如下： ```markdown | 表头 | 表头 | | ---- | ---- | | 单元格 | 单元格 | | 单元格 | 单元格 | ``` 可以设置表格的对齐方式： * -: 设置内容和标题栏居右对齐。 * :- 设置内容和标题栏居左对齐。 * :-: 设置内容和标题栏居中对齐。 | 表头 | 表头 | 表头 | |:------|:--------:|------:| | 左对齐 | 居中对齐 | 右对齐 | # Markdown 高级技巧 ## 1、支持 html 标签 不在 Markdown 涵盖范围之内的标签，都可以直接在文档里面用 HTML 撰写。 目前支持的 HTML 元素有：
等 ，如： ```markdown 使用 Ctrl+Alt+Del 重启电脑 ``` ## 2、转义 Markdown 使用了很多特殊符号来表示特定的意义，如果需要显示特定的符号则需要使用转义字符，Markdown 使用反斜杠转义特殊字符： ```markdown **文本加粗** \*\* 正常显示星号 \*\* ``` Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号： | 符号 | 含义 | |------|----------| | \\ | 反斜线 | | \` | 反引号 | | \* | 星号 | | \_ | 下划线 | | \{\} | 花括号 | | \[\] | 方括号 | | \(\) | 小括号 | | \# | 井字号 | | \+ | 加号 | | \- | 减号 | | \. | 英文句点 | | \! | 感叹号 | ## 3、公式 Markdown Preview Enhanced 使用 KaTeX 或者 MathJax 来渲染数学表达式。 KaTeX 拥有比 MathJax 更快的性能，但是它却少了很多 MathJax 拥有的特性。你可以查看 KaTeX supported functions/symbols 来了解 KaTeX 支持那些符号和函数。 默认下的分隔符： * \$...\$ 或者 \(...\) 中的数学表达式将会在行内显示。 * \$\$...\$\$ 或者 \[...\] 或者 \`\`\`math 中的数学表达式将会在块内显示。 ```markdown $f(x) = sin(x) + 12$ $$\sum_{n=1}^{100} n$$ ``` $f(x) = sin(x) + 12$ $$\sum_{n=1}^{100} n$$ 范例: $$ \begin{matrix} a & b \\ c & d \end{matrix} $$ $$ \left[ \begin{matrix} a & b \\ c & d \end{matrix} \right] $$ $$ \begin{bmatrix} a & b \\ c & d \end{bmatrix} $$ $$ \begin{Bmatrix} a & b \\ c & d \end{Bmatrix} $$ $$ \left[ \begin{matrix} 1 & 2 & \cdots & 4 \\ 7 & 6 & \cdots & 5 \\ \vdots & \vdots & \ddots & \vdots \\ 8 & 9 & \cdots & 0 \\ \end{matrix} \right] $$ $\bigl( \begin{smallmatrix} l&l\\j&z \end{smallmatrix} \bigr)$ $$ \left[ \begin{array}{cc|c} 1 & 2 & 3 \\ 4 & 5 & 6 \end{array} \right] \tag{7} $$ $$ \begin{CD} A @>a>> B \\ @VbVV @AAcA \\ C @= D \end{CD} $$ ### 3.1 上标、下标、求和、括号 | 说明 | 语法(输入在两个\$\$之间) | 显示 | | --------- | ---- | ---- | | 上标 | x^{2}, x^{y}, e^{-3} | $x^2$, $x^y$, $e^{-3}$ | | 下标 | x_{0}, a_{1}, T_{-1} | $x_0$, $a_1$, $T_{-1}$ | | 求和 | \sum | $\sum$ | | 求和上下标 | \sum_{0}^{3}, \sum_{0}^{\infty}, \sum_{-\infty}^{\infty} | $\sum_{0}^{3}$, $\sum_{0}^{\infty}$, $\sum_{-\infty}^{\infty}$ | | 中括号 | [s(s+1)-(s-1)(s-2)] | $[s(s+1)-(s-1)(s-2)]$ | | 花括号 | \lbrace x-y \rbrace | $\lbrace x-y \rbrace$ | | 花括号 | \\\{ x-y \\\} | $\{ x-y \}$ | | 尖括号 | \lrangle x-y \rangle | $\langle x-y \rangle$ | | 尖括号 | \ | $$ | ### 3.2 三角函数、指数、对数 | 说明 | 语法(输入在两个\$\$之间) | 显示 | | --------- | ----------------------- | ----------- | | sin | \sin(x) | $\sin(x)$ | | cos | \cos(x) | $\cos(x)$ | | tan | \tan(x) | $\tan(x)$ | | cot | \cot(x) | $\cot(x)$ | | csc | \csc(x) | $\csc(x)$ | | sec | \sec(x) | $\sec(x)$ | | log | \log_2 10 | $\log_2 10$ | | ln | \ln2 | $\ln2$ | | | \backsim | $\backsim$ | | | \cong | $\cong$ | | | \angle A | $\angle A$ | ### 3.3 运算符 | 说明 | 语法(输入在两个\$\$之间) | 显示 | | ---------- | -------------------------------------- | ----------- | | 乘 | \times | $\times$ | | 除 | \div | $\div$ | | 分数 | \frac{x}{y} | $\frac{x}{y}$ | | 复杂分数 | a+b+c+d+e+F \over g+h+i+i+k+l | $a+b+c+d+e+F \over g+h+i+i+k+l$ | | 加减 | \pm | $\pm$ | | 减加 | \mp | $\mp$ | | 求和 | \sum | $\sum$ | | 求积 | \prod | $\prod$ | | | \coprod | $\coprod$ | | 微分 | \partial | $\partial$ | | 积分 | \oint, \displaystyle\oint | $\oint$, $\displaystyle\oint$ | | 积分 | \int, \displaystyle\int | $\int$, $\displaystyle\int$ | | 积分 | \iint, \displaystyle\iint | $\iint$, $\displaystyle\iint$ | | 积分 | \iiint, \displaystyle\iiint | $\iiint$, $\displaystyle\iiint$ | | 不等于 | \neq | $\neq$ | | ̸大于等于 | \geq | $\geq$ | | 小于等于 | \leq | $\leq$ | | 约等于 | \approx | $\approx$ | | 恒等于 | \equiv | $\equiv$ | | 不大于等于 | x+y \ngeq z | $x+y \ngeq z$ | | 点乘 | a \cdot b | $a \cdot b$ | | 星乘 | a \ast b | $a \ast b$ | | 分式 | \frac{b}{a}、\frac{x}{y}、\frac{1}{x+1} | $\frac{b}{a}$、$\frac{x}{y}$、$\frac{1}{x+1}$ | | | \mid | $\mid$ | | | \nmid | $\mid$ | | | \circ | $\circ$ | | | \backslash | $\backslash$ | | | \prime | $\prime$ | | | \lim | $\lim$ | | | \infty | $\infty$ | | | \nabla | $\nabla$ | ### 3.4 数学符号 | 说明 | 语法(输入在两个\$\$之间) | 显示 | | ---------- | -------------------------------------- | ----------- | | 无穷 | \infty | $\infty$ | | 矢量 | \vec{a} | $\vec{a}$ | | 一阶导数 | \dot{x} | $\dot{x}$ | | 二阶导数 | \ddot{x} | $\ddot{x}$ | | 算数平均值 | \bar{a} | $\bar{a}$ | | 概率分布 | \hat{a} | $\hat{a}$ | | 虚数i,j | \imath, \jmath | $\imath$, $\jmath$ | | 四种省略号 | \ldots；\cdots；\vdots；\ddots | $\ldots$；$\cdots$；$\vdots$；$\ddots$ | ### 3.5 高级运算符 | 说明 | 语法(输入在两个\$\$之间) | 显示 | | ---------- | -------------------------------------- | ----------- | | 平均数运算 | \overline{xyz} | $\overline{xyz}$ | | 开二次方运算 | \sqrt x | $\sqrt x$ | | 开方运算 | \sqrt[x]{-y} | $\sqrt[x]{-y}$ | | 极限运算一 | \lim^{x \to \infty}_{y \to 0}{\frac{x}{y}} | $\lim^{x \to \infty}_{y \to 0}{\frac{x}{y}}$ | | 极限运算二 | \displaystyle \lim^{x \to \infty}_{y \to 0}{\frac{x}{y}} | $\displaystyle \lim^{x \to \infty}_{y \to 0}{\frac{x}{y}}$ | | 求和运算一 | \sum^{x \to \infty}_{y \to 0}{\frac{x}{y}} | $\sum^{x \to \infty}_{y \to 0}{\frac{x}{y}}$ | | 求和运算二 | \displaystyle \sum^{x \to \infty}_{y \to 0}{\frac{x}{y}} | $\displaystyle \sum^{x \to \infty}_{y \to 0}{\frac{x}{y}}$ | | 积分运算一 | \int^{\infty}_{0}{xdx} | $\int^{\infty}_{0}{xdx}$ | | 积分运算二 | \displaystyle \int^{\infty}_{0}{xdx} | $\displaystyle \int^{\infty}_{0}{xdx}$ | | 微分运算 | \frac{\partial x}{\partial y}、\frac{\partial^2x}{\partial y^2} | $\frac{\partial x}{\partial y}、\frac{\partial^2x}{\partial y^2}$ | ### 3.6 集合运算 | 说明 | 语法(输入在两个\$\$之间) | 显示 | | ---------- | -----------------------------| ------------------------------- | | 空集 | \emptyset | $\emptyset$ | | 属于 | x \in y | $x \in y$ | | 不属于 | x \notin y | $x \notin y$ | | 子集 | x \subset y、x \supset y | $x \subset y$、$x \supset y$ | | 真子集 | x \subseteq y、x \supseteq y | $x \subseteq y$、$x \supseteq y$ | | 并集 | x \cup y | $x \cup y$ | | 交集 | x \cap y | $x \cap y$ | | 差集 | x \setminus y | $x \setminus y$ | | 同或 | x \bigodot y | $x \bigodot y$ | | 同与 | x \bigotimes y | $x \bigotimes y$ | | 异或 | x \bigoplus y | $x \bigoplus y$ | | 实数集合 | \mathbb{R} | $\mathbb{R}$ | | 自然数集合 | \mathbb{Z} | $\mathbb{Z}$ | | | \vee | $\vee$ | | | \wedge | $\wedge$ | | | \uplus | $\uplus$ | | | \top | $\top$ | | | \bot | $\bot$ | | | \complement | $\complement$ | ### 3.7 向量和箭头 | 说明 | 语法(输入在两个\$\$之间) | 显示 | | ---------- | -----------------------------| ------------------------------- | | 向量 x | \vec{x} | $\vec{x}$ | | x 上方左箭头 | \overleftarrow{x} | $\overleftarrow{x}$ | | x 上方右箭头 | \overrightarrow{x} | $\overrightarrow{x}$ | | 左箭头 | \leftarrow | $\leftarrow$ | | 右箭头 | \rightarrow | $\rightarrow$ | | 向上的箭头 | \uparrow | $\uparrow$ | | 向下的箭头 | \downarrow | $\downarrow$ | | | \Leftarrow | $\Leftarrow$ | | | \Rightarrow | $\Rightarrow$ | | | \Uparrow | $\Uparrow$ | | | \Downarrow | $\Downarrow$ | ### 3.8 逻辑运算 | 说明 | 语法(输入在两个\$\$之间) | 显示 | | ---------- | -----------------------------| ------------------------------- | | 因为 | \because | $\because$ | | 所以 | \therefore | $\therefore$ | | 非 | \neg | $\neg$ | | 任意 | \forall | $\forall$ | | 存在 | \exists | $\exists$ | | 不包含于 | \not\subset | $\not\subset$ | | 不小于 | \not< | $\not<$ | | 不大于 | \not> | $\not>$ | | 不等于 | \not= | $\not=$ | ### 3.9 戴帽运算 | 说明 | 语法(输入在两个\$\$之间) | 显示 | | ---------- | -----------------------------| ------------------------------- | | | \hat{xy} | $\hat{xy}$ | | | \widehat{xyz} | $\widehat{xyz}$ | | | \bar{y} | $\bar{y}$ | | | \tilde{xy} | $\tilde{xy}$ | | | \widetilde{xyz} | $\widetilde{xyz}$ | | | \acute{y} | $\acute{y}$ | | | \breve{y} | $\breve{y}$ | | | \check{y} | $\check{y}$ | | | \grave{y} | $\grave{y}$ | | | \dot{x} | $\dot{x}$ | | | \ddot{x} | $\ddot{x}$ | ### 3.10 公式 1. 为公式加注释 ```math $f(x)= \begin{cases} 0,& \text{if x is even} \\ 1, & \text{if x is odd} \end{cases}$ ``` $f(x)= \begin{cases} 0,& \text{if x is even} \\ 1, & \text{if x is odd} \end{cases}$ 2. 为公式加序号 ```math $y=ax+b \tag{公式1}$ ``` $y=ax+b \tag{公式1}$ ### 3.11 字体 1. 数字加粗 ```math $\mathbf{0123456789}$ ``` $\mathbf{0123456789}$ 2. 希腊字母加粗 ```math $\pmb{\alpha\beta}$ ``` $\pmb{\alpha\beta}$ 3. 希腊字母斜体加粗 ```math $\boldsymbol{\alpha\beta}$ ``` $\boldsymbol{\alpha\beta}$ ### 3.8 其他 | 说明 | 语法(输入在两个\$\$之间) | 显示 | | ---------- | -----------------------------| ------------------------------- | | 字体变大 | \displaystyle \frac{x+y}{y+z} | $\displaystyle \frac{x+y}{y+z}$ | | 下划线 | \underline{x+y} | $\underline{x+y}$ | | 上大括号 | \overbrace{a+b+c+d}^{2.0} | $\overbrace{a+b+c+d}^{2.0}$ | | 下大括号 | a+\underbrace{b+c}_{1.0}+d | $a+\underbrace{b+c}_{1.0}+d$| | 上位符号 | \vec{x}\stackrel{\mathrm{def}}{=}{x_1,\dots,x_n} | $\vec{x}\stackrel{\mathrm{def}}{=}{x_1,\dots,x_n}$ | ### 3.9 希腊字母 | 大写字母 | 语法(输入在两个\$\$之间) | 小写字母 | 语法(输入在两个\$\$之间) | | ---------- | ----------------------| -------- | ------------------------| | $A$ | A | $\alpha$ | \alpha | | $B$ | B | $\beta$ | \beta | | $\Gamma$ | \Gamma | $\gamma$ | \gamma | | $\Delta$ | \Delta | $\delta$ | \delta | | $E$ | E | $\epsilon$ | \epsilon | | $Z$ | Z | $\zeta$ | \zeta | | $H$ | H | $\eta$ | \eta | | $\Theta$ | \Theta | $\theta$ | \theta | | $I$ | I | $\iota$ | \iota | | $K$ | K | $\kappa$ | \kappa | | $\Lambda$ | \Lambda | $\lambda$ | \lambda | | $M$ | M | $\mu$ | \mu | | $N$ | N | $\nu$ | \nu | | $\Xi$ | \Xi | $\xi$ | \xi | | $O$ | O | $\omicron$ | \omicron | | $\Pi$ | \Pi | $\pi$ | \pi | | $P$ | P | $\rho$ | \rho | | $\Sigma$ | \Sigma | $\sigma$ | \sigma | | $T$ | T | $\tau$ | \tau | | $\Upsilon$ | \Upsilon | $\upsilon$ | \upsilon | | $\Phi$ | \Phi | $\phi$ | \phi | | $X$ | X | $\chi$ | \chi | | $\Psi$ | \Psi | $\psi$ | \psi | | $\Omega$ | \Omega | $\omega$ | \omega | ## 4、typora 画图 可以支持流程图、时序图(顺序图)、甘特图 ### 4.1、横向流程图 ```mermaid graph LR A[方形] -->B(圆角) B --> C{条件a} C -->|a=1| D[结果1] C -->|a=2| E[结果2] F[横向流程图] ``` ### 2、竖向流程图 ```mermaid graph TD A[方形] --> B(圆角) B --> C{条件a} C --> |a=1| D[结果1] C --> |a=2| E[结果2] F[竖向流程图] ``` ### 3、标准流程图 ```flow st=>start: 开始框 op=>operation: 处理框 cond=>condition: 判断框(是或否?) sub1=>subroutine: 子流程 io=>inputoutput: 输入输出框 e=>end: 结束框 st->op->cond cond(yes)->io->e cond(no)->sub1(right)->op ``` ### 4、标准流程图（横向） ```flow st=>start: 开始框 op=>operation: 处理框 cond=>condition: 判断框(是或否?) sub1=>subroutine: 子流程 io=>inputoutput: 输入输出框 e=>end: 结束框 st(right)->op(right)->cond cond(yes)->io(bottom)->e cond(no)->sub1(right)->op ``` ### 5、UML时序图(简单) ```sequence 对象A->对象B: 对象B你好吗?（请求） Note right of 对象B: 对象B的描述 Note left of 对象A: 对象A的描述(提示) 对象B-->对象A: 我很好(响应) 对象A->对象B: 你真的好吗？ ``` ### 6、UML时序图(复杂) ```sequence Title: 标题：复杂使用 对象A->对象B: 对象B你好吗?（请求） Note right of 对象B: 对象B的描述 Note left of 对象A: 对象A的描述(提示) 对象B-->对象A: 我很好(响应) 对象B->小三: 你好吗 小三-->>对象A: 对象B找我了 对象A->对象B: 你真的好吗？ Note over 小三,对象B: 我们是朋友 participant C Note right of C: 没人陪我玩 ``` ### 7、UML时序图(标准) ```mermaid %% 时序图例子,-> 直线，-->虚线，->>实线箭头 sequenceDiagram participant 张三 participant 李四 张三->王五: 王五你好吗？ loop 健康检查 王五->王五: 与疾病战斗 end Note right of 王五: 合理 食物
看医生... 李四-->>张三: 很好! 王五->李四: 你怎么样? 李四-->王五: 很好! ``` ### 8、甘特图 ```mermaid gantt dateFormat YYYY-MM-DD title 软件开发甘特图 section 设计 需求 :done, des1, 2014-01-06,2014-01-08 原型 :active, des2, 2014-01-09, 3d UI设计 : des3, after des2, 5d 未来任务 : des4, after des3, 5d section 开发 学习准备理解需求 :crit, done, 2014-01-06,24h 设计框架 :crit, done, after des2, 2d 开发 :crit, active, 3d 未来任务 :crit, 5d 耍 :2d section 测试 功能测试 :active, a1, after des3, 3d 压力测试 :after a1 , 20h 测试报告 : 48h ``` ### 9、饼形图 ```mermaid pie title 饼形图 "A" : 42.96 "B" : 50.05 "C" : 10.01 ```