Markdowm 简易教程
基本介绍
Markdown 是一种轻量级标记语言。其显著特点在于纯文本、兼容性强、格式转换方便等。
在本次 PA 实验中,我们希望你能用 Markdown 来编写各阶段报告。在这里我们强烈推荐 Typora,这是一款专为Markdown 设计,可以直接预览文档样式的编辑器,可以通过 Typora官网 下载。
常用语法
使用一对 ` 包裹的内容将会以代码样式显示,如以下 markdown 代码
`int`
将被渲染为:
int
输入
``` + 回车
可以输入代码块,报告中经常需要附上代码,在三个点后输入语言名称,编辑器将对代码做高亮操作,如以下 markdown 代码```c static int a = 1;
将被渲染为: ```c static int a = 1;
通过拖拽或者复制插入图片(默认路径为绝对路径,你可以把这个图片复制到当前文档的路径来方便管理),报告中经常需要提交截图证明,如以下 markdown 代码
![FAN1Et.jpg](../images/FAN1Et.jpg)
将被渲染为:
使用
[]()
的方式附上超链接,可以用来说明你的参考来源等,如以下 markdown 代码[百度](https://www.baidu.com)
将被渲染为:
输入
[TOC] + 回车
将会产生一个目录,完成所有报告内容之后可以在开头生成一个目录,如以下 markdown 代码[TOC]
将被渲染为(网页上可能显示不出来):
[TOC]
使用
--- + 回车
产生水平分割线,如以下 markdown 代码---
将被渲染为:
使用「* + 空格」创建无序列表,如以下 markdown 代码
* 123 * 456 * 789
将被渲染为:
- 123
- 456
- 789
使用
数字 + . + 空格
创建有序列表,按点说明,如以下 markdown 代码1. 第一点 2. 第二点
将被渲染为:
- 第一点
- 第二点
使用
**
包裹的内容再回车有黑体效果,可以用来强调说明,如以下 markdown 代码**此处重点**
将被渲染为:
此处重点
使用
> + 回车
来插入块引用,一般用来做注释说明,如以下 markdown 代码> 这是一个块引用!
将被渲染为:
这是一个块引用!
使用
### + 空格
来引入标题,标题层级取决于#
的个数,如以下 markdown 代码# 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题
熟悉以上 11 条语法足够够用来书写 PA 报告,更多的用法可以自己上网搜索。
补充说明
在 Typora 中还可以方便的插入表格,数学公式,甚至是 Emoji 等。具体的语法在此不做陈述,需要用到的时候读者可以自行摸索。我们有足够的理由相信,你能在 20 分钟内学会 Markdown 的基本使用,加油!