贡献指南
可加入编辑部提交贡献文档,或直接为本项目提交PR来贡献内容!
极简markdown入门指南
如果你不想阅读长篇大论,可以直接划到本页面的最下方使用所见即所得的编辑器尝试markdown语法,在实践中学习!
前言
作为一种标记语言,Markdown的入门门槛其实和word差别不大,只需要熟悉一些关键符号,你就可以开始上手开始编辑markdown文档了。
我们仅仅使用接下来所述的一部分语法,事实上,这是一个能够满足本手册编辑排版需要的markdown语法的很小的一个子集:
- 一级/二级/三级标题
- 正文
- 加粗
- 斜体
- 超链接
- 必要的表格
- 图片
- 公式
下面我们将最简单的展现一些示例:
多级标题
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
正文
不带任何格式特殊符号的文字即为正文,正文中如果包含格式特殊符号 如:#,$,^,*
等,请在特殊符号前面加上反斜杠\
示例:
这是普通正文内容,使用\*星号\*不会被解析为斜体
效果:
这是普通正文内容,使用*星号*不会被解析为斜体
加粗
用两个星号包裹文字:
**这是加粗文本**
效果:这是加粗文本
斜体
用一个星号包裹文字:
*这是斜体文本*
效果:这是斜体文本
超链接
方括号内放文字,圆括号内放URL:
[华工手册官网](https://manual.华南原神大学.com)
效果:华工手册官网
表格
用竖线分隔列,第二行用连字符定义表头:
|课程|学分|
|---|---|
|微积分(II)(上)|5|
|工科数学分析(下)|5|
|工科数学分析(下)|5|
效果:
课程 | 学分 |
---|---|
微积分(II)(上) | 5 |
工科数学分析(下) | 5 |
工科数学分析(下) | 5 |
提示:第二行里面 " - " 横杠的个数是任意的,采用三个只是为了好看
引用
小于号(英文半角)加空格,后面即为引用内容。
语法:
> 这里是引用的内容
效果:
这里是引用的内容
图片
感叹号开头,方括号内是替代文本(加载不出来的时候显示的文本,有时候也会被解释为图片的题注),圆括号内是图片路径。
语法:

效果:
公式(高级)
用美元符号包裹LaTeX公式:
如果你对LaTeX语法不甚熟悉,你可以使用可视化编辑器 在线LaTeX公式编辑器 进行公式编辑,并在输出区域下方点击“输出代码 > LaTeX”复制LaTeX代码,粘贴到下方的双美元符号之间,即可完成公式输入。
(单美元符号)行内公式:$ E=mc^2 $
(双美元符号)独立公式块:
$$
\sum_{i=1}^n i = \frac{n(n+1)}{2}
$$
效果:
行内公式:$ E=mc^2 $
独立公式块: $$ \sum_{i=1}^n i = \frac{n(n+1)}{2} $$
结语
掌握以上基础语法,你已能完成90%的文档排版需求。立即开始你的写作之旅吧!