Markdown 语法速查

Markdown 写作速查:标题、图片、表格、代码块、按钮、键盘徽标、消息栏与 mermaid 图表的写法一页通。

本页是本站支持的 Markdown 写法速查,每个小节的展示效果就是实际渲染结果——查看源码即可复制写法。

标题与正文

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

正文段落里可以用常用的行内样式:加粗、斜体、删除线、行内代码、超级链接。上标与下标用 HTML 标签:53 = 125、水是 H2O。

图片

文章里的图片点击可进入全屏预览(灯箱)。一篇文章有多张图时,可以左右箭头或方向键切换,Esc 退出。

Markdown 书写示例

Markdown

一行简单文字即可插图:![图片说明](图片地址),下面那行 {: .image-right} 控制浮动方向。

引用与列表

引用块的写法:行首加 >。可以多行,也可以嵌套。

这是嵌套引用。

有序列表:

  1. Item one
    1. sub item one
    2. sub item two
    3. sub item three
  2. Item two

无序列表:

  • Item one
  • Item two
  • Item three

表格

Header1Header2Header3
cell1cell2cell3
cell4cell5cell6

冒号的位置决定对齐方向::--- 居左、:---: 居中、---: 居右。

代码块

三个反引号开头结尾,第一个反引号后写语言名(如 css)。代码块右上角有语言标签,鼠标悬停出现复制按钮。

#container {
  float: left;
  margin: 0 -240px 0 0;
  width: 100%;
}
std::map<std::string, int> ranks;
auto it = ranks.emplace("bob", 42);
bool ok = it.second;  /* true, 新插入。 */

mermaid 图表

本站原生支持 mermaid:把代码块的语言名写成 mermaid,网页里会自动渲染成图形。

flowchart TD
    A[写 Markdown 源码] --> B{站点构建}
    B -->|渲染| C[SVG 图形]
    B -->|解析失败| D[显示错误源码]
sequenceDiagram
    participant 你 as 写作者
    participant 站 as 本站
    你->>站: 提交 mermaid 代码块
    站-->>你: 网页直接出图

更多图型与写法见《Mermaid 使用教程》。

按钮

给链接加 .btn 类即可突出显示。

<a href="#" class="btn btn-success">Success Button</a>
Primary Button
Success Button
Warning Button
Danger Button
Info Button

键盘按键

用 <kbd> 标签表示键盘按键:

<kbd>W</kbd><kbd>A</kbd><kbd>S</kbd><kbd>D</kbd>

按 WASD 移动你的车。Midtown Madness!!

消息栏

在段落末尾追加 {: .message} 可以生成提示栏,适合放注意事项或摘要:

注意! 段落后加 {: .message} 即可生成这样的提示栏。