Markdown最全教程
1.基本操作
1.1 内容目录
语法:
1 | [TOC] |
1.2 标题
语法1:
1 | # 一级标题 |
语法2:(使用 = 和 - 标记一级和二级标题)
1 | 一级标题 |
1.3 引用/区块
语法:
1 | > 引用内容1 |
效果:
引用内容1
引用内容2
引用内容3
1.4 段落
语法:(段落的换行是使用两个以上空格+回车)
1 | 段落1<space><space><enter> |
2.代码块
2.1 单行代码
语法:
1 | `String str1 = "hello";` |
效果:String str1 = "hello";
2.2 多行代码(代码块)
语法1:
1 | ``` <type> |
语法2:
1 | ~~~<type> |
语法3:
1 | <TAB>int main() |
指定type代码可支持对应语法的高亮(type可省略)
代码段的语法高亮支持:
关键字[以下任何一个都可以] | 语言 |
---|---|
c#, c-sharp, csharp | C# |
java | Java |
php | PHP |
js, jscript, javascript | JavaScript |
css | CSS |
text, plain | text |
sql | SQL |
py, python | Python |
bash, shell | Shell |
sass, scss | SASS&SCSS |
perl, pl, Perl | Perl |
swift | swift |
go, golang | GO |
cpp, c | C |
applescript | AppleScript |
actionscript3, as3 | ActionScript 3.0 |
coldfusion, cf | ColdFusion |
delphi, pascal, pas | Delphi |
diff,patch | diff&patch |
erl, erlang | Erlang |
groovy | Groovy |
jfx, javafx | JavaFX |
ruby, rails, ror, rb | Ruby |
scala | Scala |
vb, vbnet | Visual Basic |
xml, xhtml, xslt, html | XML |
objc, obj-c | Objective C |
f#, f-sharp, fsharp | F# |
r, s, splus | R |
matlab | matlab |
yml | yml |
效果:
1 | int a = 10; |
特别提示:
如何在代码块中打出 ```
实际上是使用 4个`包含 3个`就可以了,想表示更多,最外层+1就好了
3.列表
3.1 无序列表
语法:
1 | * 无序列表1 |
效果:
- 无序列表1
- 无序列表2
- 无序列表3
3.2 多行无序列表
语法:
1 | * 多行无序列表1 |
效果:
- 多行无序列表1
- 多行无序列表2
- 多行无序列表3
- 多行无序列表2
3.3 有序列表
语法:
1 | 1. 有序列表1 |
效果:
- 有序列表1
- 有序列表2
- 有序列表3
3.4 多行有序列表
语法:
1 | 1. 多行有序列表1 |
效果:
- 多行有序列表1
- 多行有序列表2
- 多行有序列表2-1
- 多行有序列表2-2
- 多行有序列表3
- 多行有序列表3-1
- 多行有序列表3-2
3.5 区块中使用列表
语法:
1 | > 区块中使用列表 |
效果:
区块中使用列表
- 第一项
- 第二项
- 第一项
- 第二项
- 第三项
3.6 列表中使用区块
语法:
1 | * 第一项 |
效果:
- 第一项
菜鸟教程
学的不仅是技术更是梦想
- 第二项
3.7 任务列表
语法:
1 | - [ ] 抽烟 |
效果:
- 抽烟
- 喝酒
- 烫头
3.8 表格
语法:
1 | |姓名|性别|年龄|城市| |
说明:
1 | |:---|:左对齐 |
效果:
姓名 | 性别 | 年龄 | 城市 |
---|---|---|---|
张三 | 男 | 21 | 浙江 杭州 |
李四 | 女 | 23 | 浙江 绍兴 |
王五 | 男 | 25 | 浙江 温州 |
4. 链接
4.1 图片
语法1:(本地图片)
1 | ![avatar](/home/picture/1.png) |
语法2:(网络图片)
1 | ![avatar](https://static01.imgkr.com/temp/0004529ccbfd47c48ee9e543943a9a4a.png) |
效果2:
语法3:(Markdown 还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的<img>
标签)
1 | <img src="https://static01.imgkr.com/temp/0004529ccbfd47c48ee9e543943a9a4a.png" width="50%"> |
效果3:
4.2 超链接
语法1:(行内式链接)
1 | [LXY's blog](http://www.codingcode.cn/) |
效果1:
LXY’s blog
语法2:(自动链接)
1 | <http://www.codingcode.cn/> |
4.5 高级链接
我们可以通过变量来设置一个链接,变量赋值在文档末尾进行:
语法:
1 | [LXY's blog][anyword] |
效果:
LXY’s blog
5. 其他
5.1 斜体
语法:
1 | *斜体* |
效果:
斜体
斜体
5.2 加粗
语法:
1 | **加粗** |
效果:
加粗
加粗
5.3 下划线
语法:
1 | <u>下划线</u> |
效果:
下划线
5.4 删除线
语法:
1 | ~~删除线~~ |
效果:删除线
5.5 分隔线
语法:
1 | *** |
效果:
5.6 公式
使用两个美元符$$
包裹TeX或LaTeX格式的数学公式来实现
5.6.1 $ 表示行内公式:
语法:
1 | $3^2=9$ |
效果:(有些可能不支持)
$3^2=9$
$3^{(3-1)}=9$
$H_2SO_4$
$H_{2SO_4}$
5.6.2 $$ 表示整行公式:
语法:
1 | $$\sum_{i=1}^n a_i=0$$ |
效果:
$$\sum_{i=1}^n a_i=0$$
5.6.3 字体
语法:
1 | $ \mathsf{ABCDEFGHIJKLMNOPQRSTUVWXYZ} $ |
效果:
$ \mathsf{ABCDEFGHIJKLMNOPQRSTUVWXYZ} $
$ \mathcal{ABCDEFGHIJKLMNOPQRSTUVWXYZ} $
$ \mathscr{ABCDEFGHIJKLMNOPQRSTUVWXYZ} $
$ \mathfrak{ABCDEFGHIJKLMNOPQRSTUVWXYZ} $
5.6.4 常用公式
语法:
1 | $x_i^2$,$x_i^2+x_{i^2}$,$10^{10}$ |
效果:
$x_i^2$,$x_i^2+x_{i^2}$,$10^{10}$
$\log_2 x$
${x^y}^z+x^{y^z}$
$\sum^{j-1}{k=0}{\widehat{\gamma}{kj} z_k}$
$\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}$
$f(x_1,x_x,\ldots,x_n) = x_1^2 + x_2^2 + \cdots + x_n^2 $
$\displaystyle \lim_{t \to 0} \int_t^1 f(t), dt$
$\lim_{t \to 0} \int_t^1 f(t), dt$.
5.6.5 如果需要大小调整,大小写切换写
语法:
1 | $$\Biggl(\biggl(\Bigl(\bigl((x)\bigr)\Bigr)\biggr)\Biggr) gives (((((x)))))$$ |
效果:
$$\Biggl(\biggl(\Bigl(\bigl((x)\bigr)\Bigr)\biggr)\Biggr) gives (((((x)))))$$
5.6.6 括号自适应大小
语法:
1 | $$(\frac{\sqrt x}{y^3})$$ |
效果:
$$(\frac{\sqrt x}{y^3})$$
$$ \left(\frac{\sqrt x}{y^3}\right)$$
5.6.7 等式
语法:
1 | $$ |
效果:
$$
\begin{aligned}
a &= b + c \
&= d + e + f + g \
&= h + i
\end{aligned}
$$
5.7 符号的输入
语法:
1 | \\ 反斜线 |
效果:
1 | \ ` * _ { } [ ] ( ) # + - . ! |
5.8 特殊字符
语法:
1 | © 版权 |
效果:
© ® ™ & " ' < > ≠ ≤ ≥ ¢ £ € ¥ § × ÷ ±
5.9 使用HTML标签
不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。
目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>
等
如:
1 | 使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑 |
效果:
使用 Ctrl+Alt+Del 重启电脑
语法:
1 | <span style="color:red">分析、设计、实现、改进</span> |
效果:
分析、设计、实现、改进
5.10 脚注(VSCode支持)
语法:
1 | 脚注:Content [^1] |
效果:
脚注:Content [^1]
[^1]:Hi 这里是一个注脚,会自动拉到最后面排版
5.11 缩略(VSCode支持)
语法:
1 | *[HTML]: 超文本标记语言 |
效果:
*[HTML]: 超文本标记语言
The HTML specification
6.折叠
6.1 折叠文本
语法:
1 | <details> |
效果:
折叠文本
此处可书写文本 嗯,是可以书写文本的6.2 折叠代码块(高亮)
语法:
1 | <details> |
效果:
折叠代码块
System.out.println("折叠代码块");
System.out.println("并且代码高亮了");
6.3 折叠代码块(无法高亮)
语法:
1 | <details> |
效果:
折叠代码块
System.out.println("虽然可以折叠代码块"); System.out.println("但是代码无法高亮");
6.4 折叠功能的解读
1 | details:折叠语法标签 |
7.页内跳转
语法1:
1 | <h2 id="jump">1.基本操作</h2> |
效果1:
点我跳转
语法2:
1 | <span id="link"></span> |
效果2:
点我跳转
8.注释
语法:
1 | [^_^]:我是注释 |
效果:
9.流程图、时序图(顺序图)、甘特图
注:hexo中无法显示,vscode中可以正常显示
9.1 横向流程图
语法:
1 | ```mermaid |
效果:
1 | graph LR |
9.2 竖向流程图
语法:
1 | ```mermaid |
效果:
1 | graph TD |
9.3 标准流程图(竖向)
语法:
1 | ```flow |
效果:
1 | st=>start: 开始框 |
9.4 标准流程图(横向)
语法:
1 | ```flow |
效果:
1 | st=>start: 开始框 |
9.5 UML时序图
语法:
1 | ```sequence |
效果:
1 | 对象A->对象B: 对象B你好吗?(请求) |
9.6 UML时序图(复杂样例)
语法:
1 | ```sequence |
效果:
1 | Title: 标题:复杂使用 |
9.7 UML标准时序图
语法:
1 | ```mermaid |
效果:
1 | %% 时序图例子,-> 直线,-->虚线,->>实线箭头 |
9.8 甘特图
语法:
1 | ```mermaid |
效果:
1 | gantt |
附录
1.常用转义字符表
结果 | 描述 | 实体编号 |
---|---|---|
空格 |   |
|
! | 感叹号 | ! |
“ | 双引号 | " |
# | #号 | # |
$ | 美元符号 | $ |
% | 百分号 | % |
& | &符号 | & |
‘ | 单引号 | ' |
( | 左括号 | ( |
) | 右括号 | ) |
* | 星号 | * |
+ | 加号 | + |
, | 逗号 | , |
- | 减号 | - |
. | 点 | . |
/ | 左斜杠 | / |
0 | 数字0 | 0 |
1 | 数字 1 | 1 |
2 | 数字 2 | 2 |
3 | 数字 3 | 3 |
4 | 数字 4 | 4 |
5 | 数字 5 | 5 |
6 | 数字 6 | 6 |
7 | 数字 7 | 7 |
8 | 数字 8 | 8 |
9 | 数字 9 | 9 |
: | 冒号 | : |
; | 分号 | ; |
< | 小于 | < |
= | 等于 | = |
> | 大于 | > |
? | 问号 | ? |
@ | at符号 | @ |
A | 大写 A | A |
B | 大写 B | B |
C | 大写 C | C |
D | 大写 D | D |
E | 大写 E | E |
F | 大写 F | F |
G | 大写 G | G |
H | 大写 H | H |
I | 大写 I | I |
J | 大写 J | J |
K | 大写 K | K |
L | 大写 L | L |
M | 大写 M | M |
N | 大写 N | N |
O | 大写 O | O |
P | 大写 P | P |
Q | 大写 Q | Q |
R | 大写 R | R |
S | 大写 S | S |
T | 大写 T | T |
U | 大写 U | U |
V | 大写 V | V |
W | 大写 W | W |
X | 大写 X | X |
Y | 大写 Y | Y |
Z | 大写 Z | Z |
[ | 左方括号 | [ |
\ | 右斜杠 | \ |
] | 右方括号 | ] |
^ | 非符号 | ^ |
_ | 下滑线 | _ |
` | grave accent | ` |
a | 小写 a | a |
b | 小写 b | b |
c | 小写 c | c |
d | 小写 d | d |
e | 小写 e | e |
f | 小写 f | f |
g | 小写 g | g |
h | 小写 h | h |
i | 小写 i | i |
j | 小写 j | j |
k | 小写 k | k |
l | 小写 l | l |
m | 小写 m | m |
n | 小写 n | n |
o | 小写 o | o |
p | 小写 p | p |
q | 小写 q | q |
r | 小写 r | r |
s | 小写 s | s |
t | 小写 t | t |
u | 小写 u | u |
v | 小写 v | v |
w | 小写 w | w |
x | 小写 x | x |
y | 小写 y | y |
z | 小写 z | z |
{ | 左花括号 | { |
| | 垂直符号 | | |
} | 左花括号 | } |
~ | 波浪线 | ~ |
2. 常用 Emoji & Font-Awesome(VSCode支持)
a | b | c | d | e | f | |
---|---|---|---|---|---|---|
1 | :punch: |
:notebook: |
:e-mail: |
:smile: |
:movie_camera: |
:camera: |
2 | :fa-car: |
:telephone_receiver: |
:phone: |
:heart: |
:alarm_clock: |
:loop: |
3 | :+1: |
:books: |
:email: |
:-1: |
:bulb: |
:hammer: |
4 | :rocket: |
:book: |
:envelope: |
:sunny: |
:mag_right: |
:chart_with_upwards_trend: |
5 | :cloud: |
:bar_chart: |
:wind_chime: |
:hibiscus: |
:paperclip: |
:ghost: |
6 | :bug: |
:date: |
:balloon: |
:beers: |
:guitar: |
:headphones: |
7 | :rice: |
:guitar: |
:mortar_board: |
:house: |
:mount_fuji: |
:office: |
8 | :rocket: |
:school: |
:cupid: |
:notes: |
:shit: |
:feet: |
9 | :speech_balloon: |
效果:
a | b | c | d | e | f | |
---|---|---|---|---|---|---|
1 | :punch: | :notebook: | :e-mail: | :smile: | :movie_camera: | :camera: |
2 | :fa-car: | :telephone_receiver: | :phone: | :heart: | :alarm_clock: | :loop: |
3 | :+1: | :books: | :email: | :-1: | :bulb: | :hammer: |
4 | :rocket: | :book: | :envelope: | :sunny: | :mag_right: | :chart_with_upwards_trend: |
5 | :cloud: | :bar_chart: | :wind_chime: | :hibiscus: | :paperclip: | :ghost: |
6 | :bug: | :date: | :balloon: | :beers: | :guitar: | :headphones: |
7 | :rice: | :guitar: | :mortar_board: | :house: | :mount_fuji: | :office: |
8 | :rocket: | :school: | :cupid: | :notes: | :shit: | :feet: |
9 | :speech_balloon: |