标题格式

使用 = 和 - 标记一级和二级标题

= 和 - 标记语法格式如下：
我展示的是一级标题

我展示的是二级标题

我展示的是一级标题

我展示的是二级标题

使用 # 号标记

使用 # 号可表示 1-6 级标题，一级标题对应一个 # 号，二级标题对应两个 # 号，以此类推。

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

段落格式

段落

段落没有特殊的格式，直接编写文字就好，段落的换行是使用两个以上空格加上回车。
也可以在段落后面使用一个空行来表示重新开始一个段落。

字体

可以使用以下几种字体：
斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本

斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本

分隔线

在一行中用三个以上的星号、减号、底线来建立一个分隔线，行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线：

删除线

如果段落上的文字要添加删除线，只需要在文字的两端加上两个波浪线 ~~ 即可：
BAIDU.COM

下划线

下划线可以通过 HTML 的  标签来实现：
带下划线文本

带下划线文本

脚注

脚注是对文本的补充说明。
Markdown 脚注的格式如下:
[^要注明的文本]
创建脚注格式类似这样 1。

创建脚注格式类似这样 1。

列表

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

无序列表

  • 第一项
  • 第二项
  • 第三项

有序列表

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

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

列表嵌套

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

  1. 第一项：
  • 第一项嵌套的第一个元素
  • 第一项嵌套的第二个元素
  1. 第二项：
  • 第二项嵌套的第一个元素
  • 第二项嵌套的第二个元素
  1. 第一项：
    • 第一项嵌套的第一个元素
    • 第一项嵌套的第二个元素
  2. 第二项：
    • 第二项嵌套的第一个元素
    • 第二项嵌套的第二个元素

区块

Markdown 区块引用是在段落开头使用 > 符号 ，然后后面紧跟一个空格符号：

区块以及嵌套

区块引用
菜鸟教程
学的不仅是技术更是梦想

可以嵌套，只需要增加一层即可嵌套一层，例如“> ”为一层，"> > "为两层，以此类推。

区块使用列表

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

列表中使用区块

如果要在列表项目内放进区块，那么就需要在 > 前添加四个空格的缩进。
列表中使用区块实例如下：

  • 第一项

前面增加四个空格，即可达到这样的效果

  • 第二项

代码

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

printf() 函数

代码区块

代码区块使用 4 个空格或者一个制表符（Tab 键）。
也可以用 "```"包裹一段代码，并指定一种语言（也可以不指定）：

$(document).ready(function () {
alert('RUNOOB');
});

$(document).ready(function () {
alert('RUNOOB');
});

链接

常规链接

链接名称
或者
<链接地址>
例如：
这是一个链接 [菜鸟教程] (https://www.runoob.com)

这是一个链接 菜鸟教程

也可以直接使用链接地址：
<https://www.runoob.com>

https://www.runoob.com

高级链接

可以通过变量来设置一个链接，变量赋值在文档末尾进行：

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

这个链接用 1 作为网址变量 Google
这个链接用 runoob 作为网址变量 Runoob
然后在文档的结尾为变量赋值（网址）

图片

使用语法

  • 开头一个感叹号 !
  • 接着一个方括号，里面放上图片的替代文字
  • 接着一个普通括号，里面放上图片的网址，最后还可以用引号包住并加上选择性的 'title' 属性的文字。
![alt 属性文本](图片地址)
![alt 属性文本](图片地址 "可选标题")
例如：
![RUNOOB 图标](http://static.runoob.com/images/runoob-logo.png)
![RUNOOB 图标](http://static.runoob.com/images/runoob-logo.png "RUNOOB")

RUNOOB 图标An image to describe post MD语法
RUNOOB 图标

使用变量

这个链接用 1 作为网址变量 [RUNOOB][2].
然后在文档的结尾为变量赋值（网址）

[1]: http://static.runoob.com/images/runoob-logo.png

这个链接用 3作为网址变量 [RUNOOB][3].
然后在文档的结尾为变量赋值（网址）
[3]: http://static.runoob.com/images/runoob-logo.png

表格

创建表格

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

表头 表头
单元格 单元格
单元格 单元格
效果如下：
表头 表头
---- ----
单元格 单元格
单元格 单元格

对齐方式

  • -: 设置内容和标题栏居右对齐。
  • :- 设置内容和标题栏居左对齐。
  • :-: 设置内容和标题栏居中对齐。
    例如：
    左对齐 右对齐 居中对齐
    单元格 单元格 单元格
    单元格 单元格 单元格
    效果如下：
    左对齐 右对齐 居中对齐
    :----- ----: :----:
    单元格 单元格 单元格
    单元格 单元格 单元格

进阶功能

支持的 HTML 元素

不在 Markdown 涵盖范围之内的标签，都可以直接在文档里面用 HTML 撰写。
目前支持的 HTML 元素有：<kbd> <b> <i> <em> <sup> <sub> <br>等 ，如：

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

使用 Ctrl+Alt+Del 重启电脑

转义

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

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

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

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

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

公式

使用 KaTeX 或者 MathJax 来渲染数学表达式。
KaTeX 拥有比 MathJax 更快的性能，但是它却少了很多 MathJax 拥有的特性。可以查看 KaTeX supported functions/symbols 来了解 KaTeX 支持那些符号和函数。
默认下的分隔符：

  • $...$ 或者 \(...\) 中的数学表达式将会在行内显示。
  • $$...$$ 或者 \[...\] 或者 ```math 中的数学表达式将会在块内显示。
    例如：
    $f(x)=sin(x)+12$ $f(x)=sin(x)+12$
    例如：
$$
\begin{Bmatrix}
a & b \\
c & d
\end{Bmatrix}
$$

$$
\begin{Bmatrix}
a & b \
c & d
\end{Bmatrix}
$$

$$
\begin{Bmatrix}
a & b \\
c & d
\end{Bmatrix}
$$

$$
\begin{CD}
A @>a>> B \
@VbVV @AAcA \
C @= D
\end{CD}
$$

图形工具

流程图实例

横向流程图

graph LR
A[方形] -->B(圆角)
B --> C{条件a}
C -->|a=1| D[结果1]
C -->|a=2| E[结果2]
F[横向流程图]

graph LR
A[方形] -->B(圆角)
B --> C{条件a}
C -->|a=1| D[结果1]
C -->|a=2| E[结果2]
F[横向流程图]

竖向流程图

graph TD
A[方形] --> B(圆角)
B --> C{条件a}
C --> |a=1| D[结果1]
C --> |a=2| E[结果2]
F[竖向流程图]

graph TD
A[方形] --> B(圆角)
B --> C{条件a}
C --> |a=1| D[结果1]
C --> |a=2| E[结果2]
F[竖向流程图]

UML标准时序图

%% 时序图例子,-> 直线，-->虚线，->>实线箭头
sequenceDiagram
participant 张三
participant 李四
张三->王五: 王五你好吗？
loop 健康检查
王五->王五: 与疾病战斗
end
Note right of 王五: 合理 食物 <br/>看医生...
李四-->>张三: 很好!
王五->李四: 你怎么样?
李四-->王五: 很好!

%% 时序图例子,-> 直线，-->虚线，->>实线箭头
sequenceDiagram
participant 张三
participant 李四
张三->王五: 王五你好吗？
loop 健康检查
王五->王五: 与疾病战斗
end
Note right of 王五: 合理 食物 <br/>看医生...
李四-->>张三: 很好!
王五->李四: 你怎么样?
李四-->王五: 很好!

甘特图样例

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

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

数学公式增补

四则运算

运算类型 符号 例子
加法 + $z = x+y$
减法 - $z = x-y$
加减 \pm $z = x \pm y$
减加 \mp $z = x \pm y$
乘法 \times $z = x \times y$
点乘 \cdot $z = x \cdot y$
星乘 '\ast $z = x \ast y$
除法 \div $z= x \div y$
斜除 / $z=x / y$
分式表示1 \frac{分子}{分母} $z = \frac{x \times k +b}{x \times k -b}$
分式表示2 {分子}\over{分母} $z = {b+k \times x} \over {b-k \times x}$
绝对值 \vert $\vert x+y \vert$

上下标

类型 符号 语法 实例
上标 ^ x^4 $x^4$
下标 _ x_1 $x_1$
组合符号 {} {A}_{中国}{B}^{北京} ${A}_{中国}{B}^{北京}$

汉字、字体与格式

汉字形式，markdown是可以直接使用中文的，不需要转义字符和control sequence
字体控制 \displaystyle,例子：$\displaystyle \frac{x+y}{x-y}$

$\displaystyle \frac{x+y}{x-y}$

下划线，\underline,例子：$\underline {y=k \times x + b}$

$\underline {y=k \times x + b}$​

括号：

  • 上大括号：\overbrace{公式}
    $\overbrace{1+2+3+4+5+6}$

$\overbrace{1+2+3+4+5+6}$

  • 下大括号：\underbrace{公式}
    $\underbrace{1+2+3+4+5+6}$

$\underbrace{1+2+3+4+5+6}$

上位符号:stackrel{上位符号}{基位符号}
$\vec{x} \stackrel{\mathrm{def}}{=}{x_1,\dots,x_n}$

$\vec{x} \stackrel{\mathrm{def}}{=}{x_1,\dots,x_n}$

pandoc

--reference-doc=templates_refine.docx

2023-09-05 00:35

  1. 菜鸟教程 -- 学的不仅是技术，更是梦想！！！ ↩︎ ↩︎