Markdown的使用入门
一丶Markdown是什么
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ScNTCFyh-1689076563655)(C:\Users\10044\AppData\Roaming\Typora\typora-user-images\image-20230315094242829.png)]
Markdown
是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber)。
Markdown
允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的HTML文档。
Markdown
编写的文档可以导出HTML、Word、图片、PDF、Epub等多种格式的文档。
目前许多网站平台都是基于Markdown
写的。比如:国外的Github、Reddit、Diaspora、Stack Exchange、OpenStreeMap、SourceForge等;国内的CSDN、简书、掘金、博客园、知乎等。
推荐一款好用的Markdown
编辑器Tppora。
二丶Markdwn的优点
- 纯文本编辑,只要是支持Markdown编辑的都能获得同样的结果,摆脱排版苦恼
- 学习成本低,常用的语法很少,简单易学快速上手
- 支持跨平台同步数据
- 支持插入图片、视频等
- 随时修改,不必担心word等工具出现排版错误
三丶Markdown的基本用法
3.1 标题
使用#号标记,可以表示1-6级标题,随着#的个数递增,标题字号会越来越小,其中一级标题字号最大,六级标题字号最小。
代码如下:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
效果如下:
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
注:
- #字符和标题内容之间要有一个空格
- 标题应该置于行首,如果放入表格中可能无法正确解析
3.2 字体
星号与下划线都可以,单是斜体,双是粗体,三是粗斜体
代码 | 效果 |
---|---|
*这是斜体* | 这是斜体 |
_这是斜体_ | 这是斜体 |
**这是粗体** | 这是粗体 |
__这是粗体__ | 这是粗体 |
***这是粗斜体*** | 这是粗斜体 |
___这是粗斜体___ | 这是粗斜体 |
快捷键:
- 加粗 Ctrl+B
- 斜体 Ctrl+L
3.3 换行
Markdown的换行方式有很多种:
- 直接在一句话后敲两个空格
- 两句话之间加一个空行
- 如果你在编辑的时候,想让一行文字在显示的时候换行,就在中间加
<br/>
3.4 引用
Markdown 中引用通过符号 >
来实现。>
符号后的空格,可有可无。
在引用的区块内,允许换行存在,换行并不会终止引用的区块。如果要结束引用,需要一行空白行,来结束引用的区块。
代码:
>这是一个引用:
>>这是一个引用的引用
>>>这是一个引用的引用的引用
效果:
这是一个引用:
这是一个引用的引用
这是一个引用的引用的引用
3.5 链接
Markdown中插入链接的使用方式是:
[链接名称](链接地址)
或
<链接地址>
代码:
[这是Dzh的gitee主页](https://gitee.com/di-zehan)
或
<https://gitee.com/di-zehan>
效果:
3.6 图片
Markdown中插入图片的使用方式是:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-1e19wqSg-1689076563656)(图片地址,本地链接或者URL地址。)]
注:一般采用Ctrl+V粘贴更为方便
3.7 列表
列表分为有序列表和无序列表
- 无序列表,使用
*
、+
、-
,再加一个空格作为列表的标记 - 有序列表,使用数字并加上
.
号,再加一个空格作为列表的标记
代码:
* 无序列表 1
+ 无序列表 2
- 无序列表 3
1. 有序列表 1
2. 有序列表 2
3. 有序列表 3
效果:
- 无序列表 1
- 无序列表 2
- 无序列表 3
- 有序列表 1
- 有序列表 2
- 有序列表 3
如果想要控制列表的层级,需要在列表符号前使用Tab
代码:
+ 无序列表 2
+ 无序列表 2.1
+ 无序列表 2.2
1. 有序列表 1
1.1 有序列表 1.1
2. 有序列表 2
2.1 有序列表2.1
效果:
- 无序列表 1
- 无序列表 2
- 无序列表 2.1
- 无序列表 2.2
- 有序列表 1
1.1 有序列表 1.1 - 有序列表 2
2.1 有序列表2.1
3.8 分割线
Markdown中给出了多种分割线的样式,我们可以使用分割线让文章结构更加的清晰。
分割线的使用,可以在一行中用三个-
or*
来建立一个分割线,
注意:在分割线的上面空一行!
代码:
---
***
- - -
* * *
效果:
注:写分割线前,要空一行之后写,否则会导致前一行字体放大。
3.9 删除线
删除线的的使用,可以在要添加删除线的文字前后添加两个~
代码:
~~这是要被删除的文字~~
效果:
这是要被删除的文字
3.10 下划线
下划线的使用和html中类似,在需要添加下划线的文字首尾添加<u>文本</u>
代码:
<u>这行文字已被添加下划线</u>
效果:
这行问题已被添加下划线
3.11 代码块
Markdown中代码块有两种:
-
如果在一行内需要引用代码,只需要用反引号`引起来就好了。
-
如果是在一个块内需要引用代码,则在需要引用的代码块的前一行和后一行使用三个反引号,同时在前一个反引号后写入代码的语言。
代码:
`Hello world`java
效果:
Hello world
java
代码:
```public static void main(String[] args){
System.out.println("Hello world");
}
```
效果:
public static void main(String[] args){
System.out.println("Hello world");
}
3.12 表格
表格使用|
来分割不同的单元格,使用-
来分隔表头和其他行
:-
:将表头及单元格内容左对齐-:
:将表头及单元格内容右对齐:-:
:将表头及单元格内容居中
代码:
| 项目 | 价格 | 数量 |
| -------- | -----: | :----: |
| 计算机 | \$1600 | 5 |
| 手机 | \$12 | 12 |
| 管线 | \$1 | 234 |
效果:
项目 | 价格 | 数量 |
---|---|---|
计算机 | $1600 | 5 |
手机 | $12 | 12 |
管线 | $1 | 234 |
3.13 脚本
脚注是对文本的备注,我们时长在论文中看到脚注,在Markdown中的使用方法
代码:
使用 Markdown[^1]可以效率的书写文档, 直接转换成 HTML[^2], 你可以使用 Typora[^T] 编辑器进行书写。
[^1]:Markdown是一种纯文本标记语言
[^2]:HyperText Markup Language 超文本标记语言
[^T]:NEW WAY TO READ & WRITE MARKDOWN.
效果:
使用 Markdown1可以效率的书写文档, 直接转换成 HTML2, 你可以使用 Typora3 编辑器进行书写。
3.14 特殊符号
\\
\*
\_
\+
\.
效果:
\
*
_
+
.
四丶Markdown的高级用法
4.1 制作代办事项
我们可以用Markdown
来制作一个代办事项,格式为:-[]
表示未完成;-[x]
表示已完成
代码:
- [ ] 支持以 PDF 格式导出文稿
- [ ] 改进 Cmd 渲染算法,使用局部渲染技术提高渲染效率
- [x] 新增 Todo 列表功能
- [x] 修复 LaTex 公式渲染问题
- [x] 新增 LaTex 公式编号功能
效果:
- 支持以 PDF 格式导出文稿
- 改进 Cmd 渲染算法,使用局部渲染技术提高渲染效率
- 新增 Todo 列表功能
- 修复 LaTex 公式渲染问题
- 新增 LaTex 公式编号功能
4.2 书写公式
Markdown支持书写公式,例如书写一个一次函数公式。
代码:
$$f(x)=ax+b$$
4.3 绘制流程图
mermaid
flowchat
st=>start:Start
op=>operation:Your Operation
cond=>condition:Yes or No?
e=>end
st->op->cond
cond(yes)->e
cond(no)->op
效果:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Pxg6nM9L-1689076563657)(C:\Users\10044\AppData\Roaming\Typora\typora-user-images\image-20230315110057343.png)]
此外,Markdown
还可以绘制序列图、甘特图。
4.4 支持Html
Markdown支持原生HTML
语法,譬如,你可以用 Html 写一个纵跨两行的表格:
代码:
<table>
<tr>
<th rowspan="2">值班人员</th>
<th>星期一</th>
<th>星期二</th>
<th>星期三</th>
</tr>
<tr>
<td>李强</td>
<td>张明</td>
<td>王平</td>
</tr>
</table>
效果:
值班人员 | 星期一 | 星期二 | 星期三 |
---|---|---|---|
张三 | 李四 | 王五 |
也可以改变字体格式:
代码:
<font face="楷体" color=#00ffff size=5>改变字体格式</font>
效果:
改变字体格式
五丶总结
总之,Markdown十分的强大,抽出一些时间简单的学习一下Markdown,可以方便日后更好的写文档,大家一起加油!