Markdown 使用手册
概述
这个手册是彗星课堂基于Typora的使用手册编写的,重新调整了章节的顺序,去掉了不常用的功能。
Typora使用的是GitHub风格的Markdown语法,而原始的手册可以参考这里.
目录
标题
引用
列表、有序列表、任务列表
强调、删除线
emoji表情
代码块
数学块
表格
标题
标题使用#
号开始,注意要有空格,根据#的个数可以表示1-6级菜单
例如:
# 一级标题
## 二级标题
###### 六级标题
效果:
一级标题
二级标题
六级标题
引用
需要表明引用的时候可以使用>
符号
例如:
> 第一个引用块的第一段
>
> 引用的第二段
> 第二个引用块
效果:
第一个引用块的第一段
引用的第二段
第二个引用块
列表
列表可以使用+、-或者*号来表示(注意:中间要有个空格)
+ eggplant
+ cactus
+ slot_machine
得到的效果就是这样的
- eggplant
- cactus
- slot_machine
有序列表
有序的列表用阿拉伯数字来实现:
1. 第一步
2. 第二步
3. 第三步
效果:
- 第一步
- 第二步
- 第三步
任务列表
工作中,已经会需要建立一个任务列表,MarkDown很擅长做这个事情,任务列表有待完成和已完成两种状态。
+ [ ] 申请一台虚拟机资源
+ [ ] 修复昨天上线的BUG
+ [X] 准备下周上线的文档
- 申请一台虚拟机资源
- 修复昨天上线的BUG
- 准备下周上线的文档(已完成)
强调(斜体和加粗)
可以用*/_包围住文字表示斜体和**/__包围住位子来表示粗体,看如下的代码块:
*我斜* _我也斜_ __我粗__ **我也粗**
效果:
我斜 我也斜 我粗 我也粗
这时候可能同学会问,如果我只想输入个*号呢
另一个例子:
\* 我不是列表
\*uc\* off
上面这个代码块里我用\*
来表示*(仅仅是*,没有其他含义),否则上面第一行的文字会显示成列表的样子,而第二行的uc也没有加粗……效果如下所示:
* 我不是列表
*uc* off
删除线
删除线用~~
来实现,代码如下:
彗星是~~凶兆~~吉兆
效果:
彗星是凶兆吉兆
emoji表情
是的,MarkDown还支持emoji表情,输入以下代码
:eggplant:
:cactus:
:slot_machine:
效果
?
?
?
你就得到了茄子+仙人掌+老虎机
代码块
代码
```
public static void main (){
System.out.println("彗星课堂")
```
效果
public static void main (){
System.out.println("彗星课堂")
}
还可以选择特定语言,支持语法高亮
比如这样输入
```java
public static void main (){
System.out.println("彗星课堂")
```
得到的效果就是这样的,java的关键字用不同颜色表示出来了:
public static void main (){
System.out.println("彗星课堂")
}
数学块(Math Blocks)
利用MathJax来渲染得到的数学表达式
举一个进度管理中PERT(三点估算)的公式的例子
代码
$$t_i=\frac{a_i+4m_i+b_i}{6}$$
效果
t
i
=
a
i
+
4
m
i
+
b
i
6
t_i=\frac{a_i+4m_i+b_i}{6}
ti=6ai+4mi+bi
活动估算的时间等于最乐观估计+4倍的可能估计(中位数)+最悲观估计,然后除以6。
官方例子的代码:
$$\mathbf{V}_1 \times \mathbf{V}_2 = \begin{vmatrix}
\mathbf{i} & \mathbf{j} & \mathbf{k} \\
\frac{\partial X}{\partial u} & \frac{\partial Y}{\partial u} & 0 \\
\frac{\partial X}{\partial v} & \frac{\partial Y}{\partial v} & 0 \\
\end{vmatrix}
$$
效果:
V
1
×
V
2
=
∣
i
j
k
∂
X
∂
u
∂
Y
∂
u
0
∂
X
∂
v
∂
Y
∂
v
0
∣
\mathbf{V}_1 \times \mathbf{V}_2 = \begin{vmatrix} \mathbf{i} & \mathbf{j} & \mathbf{k} \\ \frac{\partial X}{\partial u} & \frac{\partial Y}{\partial u} & 0 \\ \frac{\partial X}{\partial v} & \frac{\partial Y}{\partial v} & 0 \\ \end{vmatrix}
V1×V2=∣∣∣∣∣∣i∂u∂X∂v∂Xj∂u∂Y∂v∂Yk00∣∣∣∣∣∣
表格
markdown也支持表格
例如:
| 菜品名称 | 数量 | 价格 |
| ------- |-----|----- |
| 暗物质 | 1 | 500 |
| 彗星尾巴| 2 | 40000|
效果
咖啡名称 | 数量 | 价格 |
---|---|---|
巧意拿铁 | 1 | 34 |
绵云冷萃 | 2 | 70 |
(完)
☕️