文章目录
Markdown概述
Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。
Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
Markdown 编写的文档后缀为 .md, .markdown。
Markdown 能被使用来撰写电子书,如:Gitbook。当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。
Markdown 常用编辑器为Typora 编辑器,Typora 支持 MacOS 、Windows、Linux 平台,且包含多种主题,编辑后直接渲染出效果。支持导出HTML、PDF、Word、图片等多种类型文件。
文章目录
一个文章有个清晰明了的目录能使人有更好的阅读体验,所以写文章的第一步就是插入一个目录
语法:
@[TOC]
目录可以插入多次
文章的任何地方都可以插入目录,但为了更好的阅读体验,推荐在文章顶部或底部插入目录
目录也可以命名(默认叫“文章目录”)
@[TOC](目录的名字)
Markdown 标题
Markdown 标题有两种格式,标题的内容会显示在目录中
# 号标记(常用)
使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。
# 一级标题
## 二级标题 Ctrl/⌘+Shift +H
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
效果:
= 和 - 标记
= 和 - 可以标记一级和二级标题,语法格式如下:
一级标题
===
二级标题
---
效果:
分割线
--- 减号(-)上方需要空行,否则就成二级标题了
*** 星号(*)不需要空行
效果:
Markdown字体效果
*斜体文本* Ctrl/⌘+I
_斜体文本_
**粗体文本** Ctrl/⌘+B
__粗体文本__
***粗斜体文本***
___粗斜体文本___
==高亮文本==
~~删除线文本~~
<ins>下划线文本</ins>
<u>下划线文本</u>
效果:
斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本
高亮文本
删除线文本
下划线文本
下划线文本
Markdown 列表
无序列表 Ctrl/⌘+Shift +U
使用星号(*)、加号(+)或是减号(-)作为列表标记:
* 第一项
* 第二项
* 第三项
+ 第一项
+ 第二项
+ 第三项
- 第一项
- 第二项
- 第三项
效果:
- 第一项
- 第二项
- 第三项
- 第一项
- 第二项
- 第三项
- 第一项
- 第二项
- 第三项
有序列表 Ctrl/⌘+Shift +O
使用数字并加上 . 号来表示,如:
1. 第一项
2. 第二项
3. 第三项
1. 第四项
1. 第五项
2. 第六项
99. 第七项
9999. 第八项
999999. 第九项
数字.空格 就表示是有序列表,所以数字可以为任何数,markdown会自动排序
效果:
- 第一项
- 第二项
- 第三项
- 第四项
- 第五项
- 第六项
- 第七项
- 第八项
- 第九项
待办列表 Ctrl/⌘+Shift +C
前缀与无序列表一样,可以使用星号(*)、加号(+)或是减号(-)作为列表标记。
后面用中括号([])表示多选框,空格表示未选中,x(大小写都可以)表示选中:
- [ ] 未完成任务
+ [X] 已完成任务
* [x] 已完成任务
效果:
- 未完成任务
- 已完成任务
- 已完成任务
列表嵌套
列表嵌套只需在子列表中的选项添加四个空格即可:
1. 第一项:
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
2. 第二项:
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素
效果:
- 第一项:
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
- 第二项:
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素
自定义列表
使用冒号(:)作为自定义列表标记:
自定义列表一
: 操作项一
: 操作项二
: 操作项三
自定义列表二
: 操作项一
: 操作项二
: 操作项三
-
自定义列表一
- 操作项一
- 操作项二
- 操作项三 自定义列表二
- 操作项一
- 操作项二
- 操作项三
Markdown 区块
区块引用
Markdown 区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号:
> 区块引用
> 区块引用
> 区块引用区块引用区块引用
效果:
区块引用
区块引用
区块引用区块引用区块引用
另外区块是可以嵌套的,一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推:
> 最外层
> > 第一层嵌套
> > > 第二层嵌套
效果:
最外层
第一层嵌套
第二层嵌套
区块中使用列表
> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项
效果:
区块中使用列表
- 第一项
- 第二项
- 第一项
- 第二项
- 第三项
列表中使用区块
如果要在列表项目内放进区块,那么就需要在 > 前添加四个空格的缩进。
* 第一项
> 第一项的第一个内容
> 第一项的第二个内容
* 第二项
> 第二项的第一个内容
> 第二项的第二个内容
效果:
- 第一项
第一项的第一个内容
第一项的第二个内容 - 第二项
第二项的第一个内容
第二项的第二个内容
Markdown 代码
代码片段 Ctrl/⌘+Shift +K
如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如:
`printf()` 函数
效果:
printf()
函数
代码区块
代码区块使用 4 个空格或者一个制表符(Tab 键)。
这是一个普通段落:
这是一个代码区块。
效果:
这是一个普通段落:
这是一个代码区块。
代码区块包裹
你也可以用 ```包裹一段代码
如果指定一种语言会生成对应的代码高亮:
```javascript
$(document).ready(function () {
alert('Hello World');
});
```
效果:
$(document).ready(function () {
alert('Hello World');
});
Markdown 链接 Ctrl/⌘+Shift +L
方法一(常用):
[链接名称](链接地址)
例:这是一个链接 [百度](https://www.baidu.com/)
效果:
这是一个链接 百度
方法二:
<链接地址>
例:<https://www.baidu.com/>
高级链接
我们可以通过变量来设置一个链接,变量赋值在文档末尾进行:
这个链接用 baidu 作为网址变量 [百度][baidu]
然后在文档的结尾为变量赋值(网址)。当然,文档末尾的变量并不会显示在文章中
[baidu]: http://www.baidu.com/
效果:
这个链接用 baidu 作为网址变量 百度
Markdown 图片 Ctrl/⌘+Shift +G
插入图片
Markdown 图片语法格式如下:
开头一个感叹号 !
接着一个方括号,里面放上图片的替代文字。
接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字。
alt 属性文本是当图片不能正常显示时显示的文本
![alt 属性文本](图片地址)
例:![图片加载失败](https://i-blog.csdnimg.cn/blog_migrate/a57a4a59c61e412894489fbcad9c461b.jpeg)
效果:
标题
title标题就是鼠标放在图片上会显示的文本
![alt 属性文本](图片地址 "可选标题")
例:![图片加载失败](https://i-blog.csdnimg.cn/blog_migrate/a57a4a59c61e412894489fbcad9c461b.jpeg "鼠标放在图片上会显示的文本")
效果:
设置图片大小
方法一:
![图片加载失败](https://i-blog.csdnimg.cn/blog_migrate/a57a4a59c61e412894489fbcad9c461b.jpeg =400x400)
方法二:
<img src="https://harveyyang-git.github.io/post-images/1591856508027.jpg" width="50%">
效果:
方法一:
在路径后添加 =数字x数字 即可设置大小(x必须小写)
方法二:
图片变量
当然,你也可以像网址那样对图片网址使用变量:
这个链接用 blog 作为网址变量 [Harvey][blog].
然后在文档的结尾为变量赋值(网址)
[blog]: https://harveyyang-git.github.io/images/avatar.png
效果:
这个链接用 blog 作为网址变量 Harvey.
Markdown 表格
制作表格
使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。
语法格式如下:
表头|表头
---|-
单元格|单元格
单元格|单元格
效果:
表头 | 表头 |
---|---|
单元格 | 单元格 |
单元格 | 单元格 |
可以看到,减号(-)的数量写多少个都和一个的效果是一样的。但是推荐写3个或3个以上,因为有一些Markdown编辑器可能不能解析。
内容对齐
使用英文冒号(:)来设定内容居左对齐、居中对齐、居右对齐
居左对齐|居中对齐|居右对齐
:---|:----:|---:
单元格|单元格|单元格
单元格单元格单元格|单元格单元格单元格|单元格单元格单元格
效果:
居左对齐 | 居中对齐 | 居右对齐 |
---|---|---|
单元格 | 单元格 | 单元格 |
单元格单元格单元格 | 单元格单元格单元格 | 单元格单元格单元格 |
Markdown入门到这里就告一段落了,熟练地使用Markdown能使你专注于写作,从而写出高质量的文章。
最后,祝大家都能熟练使用Markdown写出高质量的文章,觉得文章不错别忘了点个赞哟(=-ω-=)。