概述
本文不是 Markdown 入门教程,而是收录各种 Markdown 编辑器的语法及快捷键,方便查询和扩展
目前整理收录了以下语法:
- GitHub
- 有道云笔记
- VSCode 的 Markdown Preview Enhanced
- VSCode 的 Markdown All in One
常用语法
标题
- 使用 N 个
#
表示 N 级标题,填上空格,可闭合 - 类 Setext:
=
最高阶标题;-
第二阶标题
斜体
内容两端使用 *
,且不加空格,即 HTML 中的 <em>
*内容*
=> 内容
粗体
内容两端使用 *
,且不加空格,即 HTML 中的 <strong>
**文字
=> 文字
删除线
内容两端使用 ~~
,且不加空格
~~Word~~
=> Word
分割线
使用三个及以上的 *
/-
/_
---
显示为:
列表
无序列表
- 使用
*
/+
/-
,符号和内容空一格
有序列表
- 数字加点
.
,空一格再填写内容,可嵌套 Markdown 语法
1. A
1. a
2. b
- c
2. B
显示如下:
- A
- a
- b
- b
- B
引用
- 使用
>
表示说明的文本 - 可多层嵌套 Markdown 语法
> This is quote
> > This is *quote* in quote
显示如下:
This is quote
This is quote in quote
嵌套缩进
- 列表多段落用 1~3 空格
或 1 Tab
- 列表内引用
>
缩进 1 次 - 列表内引用代码缩进 2 次
链接
行内式
[]
内注明显示的文本()
内填写 URI,可以是本文档的内容" "
内填写鼠标悬停时的说明,需与链接空一格
代码
This is [Bing](http://www.bing.com/ "Bing")
显示为:
This is Bing
参考式
- 在文件的 任意 处,定义标记的链接内容
- 用 ID 作为索引,可以是数字、文本符号
(title)可放到下一行,也可以缩进
This is [Bing][ID]
<!-- 注意需至少空一行,不过写在一起也就失去了参考式的价值了 -->
[ID]: http://www.bing.com/ "Bing"
显示为:
This is Bing
目录
- 在文章前填写
[TOC]
- 使用 列表 加 链接 的形式
- MPE:在任意位置插入
<!-- @import "[TOC]" {cmd="toc" depthFrom=2 depthTo=3 orderedList=false} -->
注脚
使用 [^ID]
表示注脚
1. 一个注脚[^footnote]的样例
2. 第二个注脚[^footnote2]的样例
显示为:
图像
URI
![描述](URI "悬停时的注释")
描述
为网络出错时的文字叙述URI
之后空一格,填写鼠标悬停时的注释URI
可以为网络资源,也可以是本地图片
base64
<img src="data:img/扩展名;base64,base64编码" />
因 Base64 较长,故可用参考式的方式将 Base64 字符串置于文章末尾
<img>
标签
Markdown 兼容 HTML 标记语言,可使用 HTML 的 div
标签
- 大小
<img width = "300" height = "200" alt="图片名称" align=center />
- 居中
<div align="center"> ... </div>
代码块
- 行内代码块:`
- 非代码:```
- 代码块:
- 4 空格 或 1 Tab 缩进
- 1 对 ``` 跨行引用
扩展语法
- 语法高亮:在代码块前的 ``` 行注明
- 行号显示:
{class:"line-numbers"}
表格
基于 HTML,可以用相关 <table>
标签创建多种样式
- 用
|
、-
标记表格 - 栏与栏间用
|
- 标题行与数据行用
-
分隔
Markdown
| 项目 | 价格 | 数量 |
| ----- | ------ | ---- |
| 手机 | \$12 | 12 |
| 管线 | \$1 | 234 |
显示为:
项目 | 价格 | 数量 |
---|---|---|
手机 | $12 | 12 |
管线 | $1 | 234 |
HTML
<table>
<tr>
<th>项目</th>
<th>价格</th>
<th>星期</th>
</tr>
<tr>
<td>计算机</td>
<td>$1600</td>
<td>5</td>
</tr>
</table>
显示为:
项目 | 价格 | 星期 |
---|---|---|
计算机 | $1600 | 5 |
移动硬盘 | $80 | 50 |
Todo 列表
[ ]
(未完成)或[x]
(已完成)- 支持子列表嵌套 Markdown 语法
- [ ] **Markdown 开发**
- [ ] 支持以 PDF 格式导出文稿
- [x] 新增 Todo 列表功能
- [x] 改进 LaTex 功能
- [x] 修复 LaTex 公式渲染问题
- [x] 新增 LaTex 公式编号功能
- [ ] **七月旅行准备**
- [ ] 准备邮轮上需要携带的物品
- [x] 购买七月一日的船票
显示如下:
- [ ] Markdown 开发
- [ ] 支持以 PDF 格式导出文稿
- [x] 新增 Todo 列表功能
- [x] 改进 LaTex 功能
- [x] 修复 LaTex 公式渲染问题
- [x] 新增 LaTex 公式编号功能
- [ ] 七月旅行准备
- [ ] 准备邮轮上需要携带的物品
- [x] 购买七月一日的船票
本博客所用的解析器貌似不支持 -_-
转义
- 使用反斜线
\
,以下内容可能需转义:\\
=> \:反斜线\`` => \
:反引号\*
=> *:星号\_
=> _:底线\{\}
=> {}:花括号\[\]
=> []:方括号\(\)
=> ():括弧\#
=> #:井字号\+
=> +:加号\-
=> -:减号\.
=> .:英文句点\!
=> !:惊叹号
<
:<
&
:&
©
:©
首行缩进
- 半方大的空白
 
或 
- 全方大的空白
 
或 
- 不断行的空白格
或 
扩展语法
Visual Studio Code 插件 Markdown Preview Enhanced
- 目录:
- 在任意位置插入
<!-- @import "[TOC]" {cmd="toc" depthFrom=2 depthTo=3 orderedList=false} -->
- 代码
--- toc: depth_from:2 depth_to:4 ordered:false ---
- 在任意位置插入
- 批注:
- 高亮:
== ==
- 注释:{>>注释<<}
- 下划线:{下划线内容}
- 高亮:
- 表格
^
向上合并单元格,>
向右合并单元格
- 在文档里运行代码
- 导入文件:
@import "file"