写作指南
Admonition
可以使用
!!! [note | warning | abstract | info | tip | success |faliure| danger | bug | example | quote]
来生成矩形框(注意正文部分需要缩进一个tab, 不能用空格)
```
!!! note
This is note
!!! warning
This is warning
!!! warning "可指定显示的字符串"
This is warning
???+ tips
可折叠,但是默认展开
??? tips
可折叠
!!! info inline "lhs"
在左边
!!! info inline end "rhs"
在右边
```
比如上述代码会有以下效果
Note
This is note
Warning
This is warning
可指定显示的字符串
This is warning
Tips
可折叠,但是默认展开
Tips
可折叠
lhs
在左边!
Success
rhs
在右边!
Tip
选项卡 (content tabs)
有时候,我们需要将不同的内容放在不同的选项卡下。比如描述不同编程语言下对一个 api 的访问
=== "c"
\`\`\`c
#include <stdio.h>
int main() {return 0;}
\`\`\`
=== "cpp"
\`\`\`cpp
#include <iostream>
int main() {return 0;}
\`\`\`
#include <stdio.h>
int main() {return 0;}
#include <iostream>
int main() {return 0;}
高亮块
-
可以使用
<span class="box box-颜色">文本</span>
来给文字加背景, 比如green,red,yellow...- 绿色
- 红灯
- 黄色
- 蓝色
- 灰色
字体大小调整
-
可以使用 \(\LaTeX\) 语法来改变字体大小
$\small 你是谁$
\(\small 你是谁\)$\large 你是谁$
\(\large 你是谁\)$\Large 你是谁$
\(\Large 你是谁\)$\LARGE 你是谁$
\(\LARGE 你是谁\)$\huge 你是谁$
\(\huge 你是谁\)