markdown 基本语法

字体样式

说明

使用*(或_) 和 **(或__) 表示斜体和粗体
使用 / 表示下划线 ,使用~~ 表示~~删除线~~
使用^(或^^)表示^上标或_下标
使用 ! 号+数字表示字体大小
使用两个(三个)!号+RGB 颜色表示字体颜色(背景颜色)

示例

[!!#ff0000 红色超链接!!](http://www.qq.com)
[!!#ffffff !!!#000000 黑底白字超链接!!!!!](http://www.0l0.net)
[新窗口打开](http://www.0l0.net){target=_blank}
鞋子 !32 特大号!
大头 ^`儿子`^ 和小头 ^^`爸爸`^^
爱在~~西元前~~**当下**

效果
红色超链接
 黑底白字超链接
 新窗口打开
鞋子特大号
大头 ^儿子和小头 _爸爸
爱在~~西元前~~当下

标题设置

说明

在文字下方加 === 可使上一行文字变成一级标题
在文字下方加 --- 可使上一行文字变成二级标题
在行首加井号（#）表示不同级别的标题，例如：# H1, ##H2, ###H3

超链接

说明

使用 [描述](URL) 为文字增加外链接
使用 [描述](URL){target=_blank} 为文字增加新开窗口的外链接
使用<URL>插入一个链接
URL 会自动转成链接

示例

这是 [有所得](http://www.0l0.net) 的链接。

这是 [一个引用的][引用一个链接] 的链接。

这是一个包含中文的链接<http://0l0.net/docs?s=中文>，中文
直接识别成链接：http://0l0.net/docs?s=中文，中文 用空格结束

这是一个[重新打开浏览器窗口](http://0l0.net){target=_blank}的外部链接

[引用一个链接]
[引用一个链接]: http://0l0.net

效果
这是有所得的链接。

这是一个引用的的链接。

这是一个包含中文的链接http://0l0.net/docs?s=中文，中文
直接识别成链接：http://0l0.net/docs?s=中文，中文用空格结束

这是一个重新打开浏览器窗口的外部链接

引用一个链接

无序列表

说明

在行首使用 *，+，- 表示无序列表

示例

- 无序列表项 一`默认`
- 无序列表项 二
  - 无序列表2.1
  - 无序列表2.2
- 无序列表项 三
  + 无序列表3.1`空心圆`
  + 无序列表3.1
- 无序列表四
  * 无序列表4.1`实心方块`
  * 无序列表4.2

效果

无序列表项一默认
无序列表项二
- 无序列表2.1
- 无序列表2.2
无序列表项三
- 无序列表3.1空心圆
- 无序列表3.1
无序列表四
- 无序列表4.1实心方块
- 无序列表4.2

有序列表

说明

在行首使用数字、字母、汉字和点表示有序列表

示例

1. 有序列表项 一`阿拉伯数字`
1. 有序列表项 二
  I. 有序列表项 2.1`罗马数字`
  I. 有序列表项 2.2
  I. 有序列表项 2.3
1. 有序列表 三
  a. 有序列表3.1`希腊字母`
  a. 有序列表3.2
  a. 有序列表3.3
1. 有序列表 四
  一. 有序列表4.1`中文数字`
  一. 有序列表4.2
  一. 有序列表4.3

效果

有序列表项一阿拉伯数字
有序列表项二
1. 有序列表项 2.1罗马数字
2. 有序列表项 2.2
3. 有序列表项 2.3
有序列表三
1. 有序列表3.1希腊字母
2. 有序列表3.2
3. 有序列表3.3
有序列表四
1. 有序列表4.1中文数字
2. 有序列表4.2
3. 有序列表4.3

引用

说明

在行首使用 > 表示文字引用

示例

> 野火烧不尽，春风吹又生

效果

野火烧不尽，春风吹又生

行内代码

说明

使用 `代码` 表示行内代码

示例

让我们聊聊 `html`

效果
让我们聊聊 html

代码块

说明

使用三个` 表示代码块

效果

    这是一个代码块
    有两行

插入图像

说明

使用 ![描述](图片链接地址) 插入图像
截图，在编辑器中粘贴（ctrl+V）也可以插入图像
使用![描述#宽度#高度#对齐方式](图片链接地址) 可以调整图片大小[^专有语法提醒]

示例

标准图片  ![一个logo#100px](/static/images/logo.jpg)
设置图片大小(相对大小&绝对大小)  ![一个logo#10%#50px](/static/images/logo.jpg)
设置图片对齐方式：
**左对齐+边框**
![一个logo#auto#100px#left#border](/static/images/logo.jpg)
**居中+边框+阴影**
![一个logo#auto#100px#center#B#shadow](/static/images/logo.jpg)
**右对齐+边框+阴影+圆角**
![一个logo#auto#100px#right#B#S#radius](/static/images/logo.jpg)
**浮动左对齐+边框+阴影+圆角**
![一个logo#auto#100px#float-left#B#S#R](/static/images/logo.jpg)
开心也是一天，不开心也是一天
这样就过了两天

效果
标准图片
设置图片大小(相对大小&绝对大小)
设置图片对齐方式：
左对齐+边框

居中+边框+阴影

右对齐+边框+阴影+圆角

浮动左对齐+边框+阴影+圆角

开心也是一天，不开心也是一天
这样就过了两天

属性释义：

宽度：第一个 #100px 或 #10% 或 #auto
高度：第二个 #100px 或 #10% 或 #auto
左对齐：#left
右对齐：#right
居中对齐：#center
悬浮左对齐：#float-left
悬浮右对齐：#float-right
边框：#border 或 #B
阴影：#shadow 或 #S
圆角：#radius 或 #R

高阶语法手册

信息面板

说明
使用连续三个冒号:::和关键字（[primary | info | warning | danger | success]）来声明

:::primary // [primary | info | warning | danger | success] 标题
内容
:::

效果

标题

内容

手风琴

说明
使用连续三个加号+++和关键字（[ + | - ]）来声明，关键字+表示默认收起，关键字-表示默认展开

+++ 点击展开更多
内容
++- 默认展开
内容
++ 默认收起
内容
+++

效果

点击展开更多

内容

默认展开

内容

默认收起

内容

语法高亮

说明

在```后面指明语法名
加强的代码块，支持四十一种编程语言的语法高亮的显示

效果
非代码示例：

sudo apt-get install vim-gnome

Python 示例：

@requires_authorization
def somefunc(param1='', param2=0):
    '''A docstring'''
    if param1 > param2: # interesting
        print 'Greater'
    return (param2 - param1 + 1) or None

class SomeClass:
    pass

>>> message = '''interpreter
... prompt'''

JavaScript 示例：

/**
 * nth element in the fibonacci series.
 * @param n >= 0
 * @return the nth element, >= 0.
 */
function fib(n) {
  var a = 1,
    b = 1;
  var tmp;
  while (--n >= 0) {
    tmp = a;
    a += b;
    b = tmp;
  }
  return a;
}

document.write(fib(10));

脚注^[1]

说明

在段落中引用多行注释即会生成脚注
脚注中括号中的数字以引用脚注的顺序自动生成
点击脚注的数字可以跳转到脚注详情或回到引用脚注位置

格式

脚注格式：使用一对方括号[、]包围且方括号里面使用^符号开头的文本，并在后方括号后加上英文的冒号: 后面接上自定义的脚注说明,并且使用两个回车结束


[^脚注名称]: 自定义的脚注说明

或者
[^脚注名称]: 自定义的脚注说明
> 可以在脚注后面附加一些简单的markdown语法

示例

这里需要一个脚注[^脚注别名1]，另外这里也需要一个脚注[^another]。

[^脚注别名1]: 无论脚注内容写在哪里，脚注的内容总会显示在页面最底部
以两次回车结束

[^another]: 另外，脚注里也可以使用一些简单的markdown语法
>比如 !!#ff0000 这里!!有一段**引用**

效果
这里需要一个脚注^[2]，另外这里也需要一个脚注^[3]。

checklist^[1]

说明

输入[ ]或[x]，就会生成一个 checklist

示例

- [ ] AAA
- [x] BBB
- [ ] CCC

效果

公式^[1]

说明

输入$$或$，就会生成一个公式
访问 MathJax 参考更多使用方法

示例

块级公式：$$
\begin{aligned}
P(B|A)&=\frac{P(AB)}{P(A)}\\
P(\overline{B}|A)&=1-P(B|A)=1-\frac{P(AB)}{P(A)}
\end{aligned}
$$
行内公式： $e=mc^2$

效果
块级公式：

\begin{aligned} P (B | A) & = \frac{P (A B)}{P (A)} \\ P (\overset{―}{B} | A) & = 1 - P (B | A) = 1 - \frac{P (A B)}{P (A)} \end{aligned}

行内公式： $e=mc^2$

插入音视频

说明

使用 !v[描述](视频链接地址) 插入视频
- 使用 !v[描述](视频链接地址){poster=封面地址} 插入视频并配上封面
使用 !audio[描述](视频链接地址) 插入音频

示例

这是个演示视频  !video[不带封面演示视频](https://tencent.github.io/cherry-markdown/examples/images/demo.mp4)
这是个演示视频  !video[带封面演示视频](https://tencent.github.io/cherry-markdown/examples/images/demo.mp4){poster=images/demo-dog.png}
这是个假音频!audio[描述](视频链接地址)

效果

这是个演示视频

这是个假音频

带对齐功能的表格

说明

一种比较通用的markdown表格语法

示例

|项目（居中对齐）|价格（右对齐）|数量（左对齐）|
|:-:|-:|:-|
|计算机|￥1600|5|
|手机机|￥12|50|

效果

项目（居中对齐）	价格（右对齐）	数量（左对齐）
计算机	￥1600	5
手机机	￥12	50

快捷键

功能	按键(Windows)	按键(macOS)
1级标题	`Ctrl` + `1`	`⌘` + `1`
2级标题	`Ctrl` + `2`	`⌘` + `2`
3级标题	`Ctrl` + `3`	`⌘` + `3`
4级标题	`Ctrl` + `4`	`⌘` + `4`
5级标题	`Ctrl` + `5`	`⌘` + `5`
6级标题	`Ctrl` + `6`	`⌘` + `6`
加粗	`Ctrl` + `b`	`⌘` + `b`
斜体	`Ctrl` + `i`	`⌘` + `i`
插入链接	`Ctrl` + `l`	`⌘` + `l`
插入代码块	`Ctrl` + `k`	`⌘` + `k`
插入图片	`Ctrl` + `g`	`⌘` + `g`
插入公式	`Ctrl` + `m`	`⌘` + `m`

脚注

[1]该语法不是markdown通用语法，无法保证在其他markdown平台上进行正确渲染

[2]无论脚注内容写在哪里，脚注的内容总会显示在页面最底部
以两次回车结束

[3]另外，脚注里也可以使用一些简单的markdown语法

比如这里有一段引用

← 上一篇「文档权限」下一篇「markdown 绘...」 →