Markdown 的使用方法
关于 Markdown 的软件
Markdown 的历史
- Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
- Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。
- Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
- Markdown 编写的文档后缀为
.md
,.markdown
。
基础语法总结
元素 | Markdown 语法 | 示例 |
---|---|---|
标题 | # H1 ## H2 ### H3 |
|
斜体 | *变斜* | 变斜 |
粗体 | **变粗** | 变粗 |
块引用 | > block | |
有序列表 | 1. 小明 2. 小张 3. 小王 |
1. 小明 2. 小张 3. 小王 |
无序列表 | - 小明 - 小张 - 小王 |
- 小明 - 小张 - 小王 |
代码 | `code` ( ` 是键盘数字 1 左边的那个符号 ) |
code |
水平线 | --- | |
超链接 | [apple](https://www.jianshu.com/u/e2e42591fb64) | apple |
图片 |  | |
表格 | |Syntax |Description | |-- |-- | | Header | Title| | Paragraph| Paragraph | |
|
围栏代码块 | ``` code ``` |
code |
脚注 | apple.[1] [^1]:apple |
apple.[1] |
删除线 | ~apple~ | |
任务列表 | - [x] apple - [ ] Update the website |
标题设定
- 使用
#
符号进行标题标定,一级标题为#
,二级标题##
,三级标题###
,以此类推。 - 使用
--
与==
进行标题标定(要标记下在下方)。
示例:
# 我是一级标题
我也是一级标题
-------------
引用块注释
- 使用
>
进行引用块注释,块注释也可以嵌套。块注释可以与其他的叠加使用,加了感觉好看。
示例:
我是块注释
我是二级块注释
爸爸是三级
对应代码
> 我是块注释
>> 我是二级块注释
>>> 爸爸是三级
文字
- 加斜与加粗。使用
*文字*
加斜,使用**文字**
加粗,使用***文字***
加粗斜。示例:文字、文字、文字 - 删除线。
~~文字~~
。示例:文件 - 文字下有分割线。
<u>带下划线文本</u>
。示例:<u>文字</u> - 文字底纹。`文字`。示例:
文字
- 使用
\
注释掉效果。`
列表
Markdown 支持有序列表和无序列表。
无序列表使用星号 *
、加号 +
或是减号 -
作为列表标记,这些标记后面要添加一个空格,然后再填写内容(可混用):
- 使用 + 号
- 使用了 - 号
- 使用了 * 号,可以混用
对应代码:
> + 使用 + 号
> - 使用了 - 号
> * 使用了 * 号,可以混用
有序列表使用数字并加上 .
号来表示,如:
- 是 1 号
- 是 2 号
- 使用了 6 号标记,这里却显示 3 号,强制转换 ?。
对应代码:
> 1. 是 1 号
> 2. 是 2 号
> 6. 使用了 6 号标记,这里却显示 3 号,强制转换 ?。
列表也可以嵌套使用,列表嵌套只需在子列表中的选项前面添加四个空格即可:
- 第一项:
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
- 第二项:
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素
对应代码:
>1. 第一项:
> - 第一项嵌套的第一个元素
> - 第一项嵌套的第二个元素
>2. 第二项:
> - 第二项嵌套的第一个元素
> - 第二项嵌套的第二个元素
超链接与图片
- 超链接:
[文字](网址链接)
。示例:文字 - 直接使用链接:
<https://www.baidu.com>
。示例:https://www.baidu.com - 图片:
[图片](网址)
。(比超链接多了一个!)
表格
使用 |
来分隔不同的单元格,使用 -
来分隔表头和其他行。
表头 | 表头 |
---|---|
单元格 | 单元格 |
单元格 | 单元格 |
对应代码:
| 表头 | 表头 |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
对应代码:
注: :---
代表左对齐,---:
代表右对齐,:---:
代表居中对齐,-
数目至少一个,第二行必须有,否则不是表格形式。以上格式代表是三行二列的表格。
代码
使用 ``` 表示代码块
def hello():
print("hello world")
创建目录
使用 [TOC]
创建目录
效果如下:
[TOC]
分割线
使用 ---
或 ***
创造分割线