Markdown基本语法
Markdown基本语法
Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。
Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
Markdown 编写的文档后缀为 .md, .markdown。
Markdown 应用
Markdown 能被使用来撰写电子书,如:Gitbook。
当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。
优点:
1、因为是纯文本,所以只要支持Markdown的地方都能获得一样的编辑效果,可以让作者摆脱排版的困扰,专心写作。
2、操作简单。比如:WYSIWYG编辑时标记个标题,先选中内容,再点击导航栏的标题按钮,选择几级标题。要三个步骤。而Markdown只需要在标题内容前加#
即可
缺点:
1、需要记一些语法(很简单,五分钟学会)。
2、有些平台不支持Markdown编辑模式。
1 | 开启方式:设置->默认编辑器->Markdown编辑器 |
编辑器
Typora、VScode、wolai等软件均支持markdown语法,本文在Typora上编写。
Markdown标题
在想要设置为标题的文字前面加#来表示
一个#是一级标题,二个#是二级标题,以此类推。支持六级标题。
注:标准语法一般在#后跟个空格再写文字。
示例:
1 | # 这是一级标题 |
效果如下:
这是一级标题
这是二级标题
这是三级标题
这是四级标题
这是五级标题
这是六级标题
Markdown字体
要加粗的文字左右分别用两个*号包起来
要倾斜的文字左右分别用一个*号包起来
要倾斜和加粗的文字左右分别用三个*号包起来
要加删除线的文字左右分别用两个~~号包起来
示例:
1 | **这是加粗的文字** |
效果如下:
这是加粗的文字
这是倾斜的文字
*这是斜体加粗的文字*这是加删除线的文字
Markdown区块
在引用的文字前加>即可。引用也可以嵌套,如加两个>>三个>>>
n个…
示例:
1 | >这是引用的内容 |
效果如下:
这是引用的内容
这是引用的内容
这是引用的内容
Markdown分割线
三个或者三个以上的 - 或者 * 都可以。
示例:
1 | --- |
效果如下:
可以看到,显示效果是一样的。
Markdown图片
语法:
1 |  |
示例:
1 |  ](超链接地址 |
示例:
1 | [//zhihu.com) ](http: |
效果如下:
注:Markdown本身语法不支持链接在新页面中打开,如果想要在新页面中打开的话可以用html语言的a标签代替。
1 | <a href="超链接地址" target="_blank">超链接名</a> |
Markdown列表
无序列表
语法:
无序列表用 - + * 任何一种都可以
1 | - 列表内容 |
效果如下:
- 列表内容
- 列表内容
- 列表内容
有序列表
语法:
数字加点
1 | 1. 列表内容 |
效果如下:
- 列表内容
- 列表内容
- 列表内容
列表嵌套
上一级和下一级之间敲三个空格即可
- 一级无序列表内容
- 二级无序列表内容
- 二级无序列表内容
- 二级无序列表内容
- 一级无序列表内容
- 二级有序列表内容
- 二级有序列表内容
- 二级有序列表内容
- 一级有序列表内容
- 二级无序列表内容
- 二级无序列表内容
- 二级无序列表内容
- 一级有序列表内容
- 二级有序列表内容
- 二级有序列表内容
- 二级有序列表内容
Markdown表格
语法:
1 | 表头|表头|表头 |
示例:
1 | 姓名|技能|排行 |
效果如下:
姓名 | 技能 | 排行 |
---|---|---|
刘备 | 哭 | 大哥 |
关羽 | 打 | 二哥 |
张飞 | 骂 | 三弟 |
这里有一个网站可以一键生成表格
https://www.tablesgenerator.com/markdown_tables
Markdown代码
语法:
单行代码:代码之间分别用一个反引号包起来
1 | `代码内容` |
代码块:代码之间分别用三个反引号包起来,且两边的反引号单独占一行
1 | (```) |
注:为了防止转译,前后三个反引号处加了小括号,实际是没有的。这里只是用来演示,实际中去掉两边小括号即可。
示例:
单行代码
1 | `create database hero;` |
代码块
1 | (```) |
效果如下:
单行代码
1 | create database hero; |
代码块
1 | function fun(){ |
Markdown流程图
1 | ```flow |
效果如下:
Markdown 其他技巧
支持HTML 元素
不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。
目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>
等 ,如:
1 | 使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑 |
公式
Markdown Preview Enhanced 使用 KaTeX 或者 MathJax 来渲染数学表达式。
KaTeX 拥有比 MathJax 更快的性能,但是它却少了很多 MathJax 拥有的特性。你可以查看 KaTeX supported functions/symbols 来了解 KaTeX 支持那些符号和函数。
默认下的分隔符:
$...$
或者\(...\)
中的数学表达式将会在行内显示。$$...$$
或者\[...\]
或者 ````math` 中的数学表达式将会在块内显示。
1 | $$ |
输出结果为: