Markdown 使用指南
本文将主要介绍如何使用Markdown来完成实验报告。
Markdown 是一种轻量级标记语言,可用于将格式元素添加到纯文本文档中。 Markdown 由 John Gruber 于 2004 年创建,现在是世界上最受欢迎的标记语言之一。
- 纯文本:Markdown的文件是以
.md
结尾的纯文本文件,而Word等是二进制文件。文本文件可以很方便的被git
跟踪修改,且可以很方便的被分享。 - 轻量级:Markdown无需要打开笨重的Word进行文档的编写,即使使用最简单的记事本也可以对Markdown文件做修改。
- 内容和渲染效果分离:在编写Markdown文件时,你只需要关心你的内容的组织结构,而无需关心其应该怎么被排版(你只需要按照一定结构编写文章而无需关心它被渲染出来的具体样式是什么)。
- 便于嵌入数学公式和代码段:Markdown可以很方便的嵌入Latex-Based数学公式和代码段。
Typora是一个跨平台的Markdown编辑器,它具有即时渲染Markdown的特性,点击链接即可下载安装Typora。
下载安装完成后,打开Typora,你可以看到以下界面:
你可以按照Markdown的语法编写Markdown文件,编写完成后保存至某个.md
文件。你还可以方便的导出编写的Markdown到PDF,只需要点击File -> Export -> PDF
即可;Typora的渲染样式是根据主题的css
文件定义的,在Typora的Themes
菜单中已经预先提供好了一系列主题可供选择,此外你还可以根据个人的喜好编写Markdown主题。
Markdown使用#
后跟空格来声明标题,标题的级数于#
的数量一致,如:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
...
Markdown支持列举的语法,来帮助你在正文部分编写结构化的文档,例如:
- 这是一些无序列举
- 我与上面一行结构并列
- 我与前面两行结构并列
- 我是第三行的子项
- 我也是第三行的子项
- 我与第三行结构并列
1. 这是一个有序列举
2. 我是第二点
3. 我是第三点
- 我是第三点的子项,也可以和无序列举使用
- 我是第三点的子项
4. 我是第四点
需要特别提醒的是,一定不要忘记输入-
或1.
与文本之间的空格。
Markdown中被反引号包裹的部分被认为是代码段(反引号通常位于你的键盘上tab
键的上方,你需要在英文输入法下才能打出这个字符),下面是一些示例:
被一对反引号包裹的是行内代码片段,例如:代码`int x = 1;`声明并定义了一个整形变量x,其初值为1
被三对反引号包裹的是行间代码片段,例如:
```
#include <stdio.h>
int main(void) {
printf("Hello world!");
return 0;
}
```
你还可以在编写完代码后在该代码段的右下角中选择语言的类型,Typora会自动的给出好看的语法高亮方式。
与代码嵌入类似,Markdown中使用$
来标识数学公式的开始,下面是一些示例:
被一对`$`包裹的部分是行内公式,例如:这个求和公式的结果是$\sum_{i=1}^{100}=5050$。
被两对`$`包裹的部分是行间公式,例如:
$$
\sum_{i=1}^{100}=5050
$$
在Typora中嵌入图片非常简单,你只需要将希望嵌入的图片复制粘贴至对应位置即可。
上述提到的语法并不全面,这只是Markdown语法的一部分,但是已经足以帮助同学们完成日常的实验报告,如果希望了解更多的Markdown语法,可以参考Markdown指南做更详细深入的了解。