作为 typecho-markdown 的开发者,收到很多关于 Markdown 解析库的使用问题。

对于功能上的 bug 当然会第一时间进行修复,非功能上的「问题」很难一个个去教大家如何使用,于是我将自己准备的插件 Test Case 重新编辑优化,整成了一个 「Markdown 简明语法手册」。

里面列出的每一项都是我自己的会用到的 Markdown 功能,每个功能点都有示例源码和渲染结果,解析渲染工具当然是 typecho-markdown,没有出现乱码、结构错乱问题即说明插件功能正常。

语法上支持的功能点和 Cmd Markdown(作业部落)基本一致,本插件开源免费,大家用的开心就行 😉。

同时本插件和 Typora 完全兼容,理论上通过 Typora 编辑的内容使用本插件就能正常解析,直接粘贴发布无需做任何修改,因为我就一直是这样用的 😎。

本博客运行环境:

  • PHP - 7.4.4
  • Typecho - 1.2/18.10.23
  • MarkdownParse Plugin - 1.3.0 (beta,预计 5 月发布)

还在手动更新 Typecho 博客版本?
赶紧去试试 typecho-update-assistant 支持一键升级到最新版本,每次操作前均会备份,安全无虞。

因为每个人的运行环境和主题样式不一样,所以最终渲染样式供大家参考。

0.目录

使用 [TOC] 来标示插入目录,目录分级取决于文章已有的分级标题。

最高层级不一定要从一级标题开始,目录解析过程会自动识别整个目录的最高层级。

示例:

[TOC]

1. 斜体、粗体、删除线

使用***~~ 分别表示斜体、粗体和删除线。

示例:

这是 *斜体*,这是 **粗体**,这是 ~~删除线~~。

这是 斜体,这是 粗体,这是 删除线

2. 分级标题

在行首加不同数量的 # 表示不同级别的标题 (H1-H6)。

最高层级不一定要从一级标题开始,目录解析过程会自动识别整个目录的最高层级。

示例:

## 这是一个二级标题
### 这是一个三级标题
#### 这是一个四级标题
##### 这是一个五级标题

这是一个二级标题

这是一个三级标题

这是一个四级标题

这是一个五级标题

3. 外链接

使用[描述](链接地址)为文字增加外链接。

示例:

点击[程小白](https://www.chengxiaobai.cn)一起来交流探讨吧。

点击程小白一起来交流探讨吧。

4. 无序列表

使用 *+- 表示无序列表。

示例:

- 无序列表项 一
- 无序列表项 二
- 无序列表项 三
  • 无序列表项 一
  • 无序列表项 二
  • 无序列表项 三

5. 有序列表

使用数字和点表示有序列表。

示例:

1. 有序列表项 一
2. 有序列表项 二
3. 有序列表项 三
  1. 有序列表项 一
  2. 有序列表项 二
  3. 有序列表项 三

6. 文字引用

使用 > 表示文字引用。

示例:

> 有一种鸟是关不住的,因为它的每一根羽毛都闪耀着自由的光辉。

有一种鸟是关不住的,因为它的每一根羽毛都闪耀着自由的光辉。

7. 行内代码块

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

示例:

`php`

php

8. 代码块

使用 ```代码``` 表示代码块。

示例:

​```php
public function __construct(array $config = [])
{
  $this->configureDefaults($config);
}
​```
public function __construct(array $config = [])
{
  $this->configureDefaults($config);
}

9. 插入图像

使用 ![描述](图片链接地址) 插入图像。

示例:

![策略模式](http://cdn.chengxiaobai.cn/2019/02/01/strategy.png.blog)

策略模式

10. 表格支持

表格语法。

示例:

|        base_uri        |   uri   |            result            |
| :--------------------: | :-----: | :--------------------------: |
| chengxiaobai.cn/first/ | /second |    chengxiaobai.cn/second    |
| chengxiaobai.cn/first/ | second  | chengxiaobai.cn/first/second |
| chengxiaobai.cn/first  | /second |    chengxiaobai.cn/second    |
| chengxiaobai.cn/first  | second  |    chengxiaobai.cn/second    |
base_uri uri result
chengxiaobai.cn/first/ /second chengxiaobai.cn/second
chengxiaobai.cn/first/ second chengxiaobai.cn/first/second
chengxiaobai.cn/first /second chengxiaobai.cn/second
chengxiaobai.cn/first second chengxiaobai.cn/second

11. LaTeX 公式

使用 $$$ 包裹公式内容,分别代表行内公式和公式块。

示例:

这是一个行内公式:$f(x,y,z) = 3y^2z \left( 3+\frac{7x+5}{1+y^2} \right)$

这是一个公式块:
$$
F^{HLLC}=\left\{
\begin{array}{rcl}
F_L       &      & {0      <      S_L}\\
F^*_L     &      & {S_L \leq 0 < S_M}\\
F^*_R     &      & {S_M \leq 0 < S_R}\\
F_R       &      & {S_R \leq 0}
\end{array} \right.
$$

这是一个行内公式:$f(x,y,z) = 3y^2z \left( 3+\frac{7x+5}{1+y^2} \right)$

这是一个公式块:
$$
F^{HLLC}=\left\{
\begin{array}{rcl}
F_L & & {0 < S_L}\\
F^*_L & & {S_L \leq 0 < S_M}\\
F^*_R & & {S_M \leq 0 < S_R}\\
F_R & & {S_R \leq 0}
\end{array} \right.
$$

12. Mermaid(1.3.0 及之后版本支持)

将代码块的语言标记为 mermaid 即可使用 mermaid 作图,支持所有 mermaid 语法。

Pie Chart

​```mermaid
pie title NETFLIX
         "Time spent looking for movie" : 90
         "Time spent watching it" : 10
​```
pie title NETFLIX "Time spent looking for movie" : 90 "Time spent watching it" : 10

Sequence Diagram

​```mermaid
sequenceDiagram
    Alice ->> Bob: Hello Bob, how are you?
    Bob-->>John: How about you John?
    Bob--x Alice: I am good thanks!
    Bob-x John: I am good thanks!
    Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.

    Bob-->Alice: Checking with John...
    Alice->John: Yes... John, how are you?
​```
sequenceDiagram Alice ->> Bob: Hello Bob, how are you? Bob-->>John: How about you John? Bob--x Alice: I am good thanks! Bob-x John: I am good thanks! Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row. Bob-->Alice: Checking with John... Alice->John: Yes... John, how are you?

Flowchart

​```mermaid
sequenceDiagram
    Alice ->> Bob: Hello Bob, how are you?
    Bob-->>John: How about you John?
    Bob--x Alice: I am good thanks!
    Bob-x John: I am good thanks!
    Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.

    Bob-->Alice: Checking with John...
    Alice->John: Yes... John, how are you?
​```
sequenceDiagram Alice ->> Bob: Hello Bob, how are you? Bob-->>John: How about you John? Bob--x Alice: I am good thanks! Bob-x John: I am good thanks! Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row. Bob-->Alice: Checking with John... Alice->John: Yes... John, how are you?

Gantt Diagrams

​```mermaid
gantt
    title A Gantt Diagram
    dateFormat  YYYY-MM-DD
    section Section
    A task           :a1, 2014-01-01, 30d
    Another task     :after a1  , 20d
    section Another
    Task in sec      :2014-01-12  , 12d
    another task      : 24d
​```
gantt title A Gantt Diagram dateFormat YYYY-MM-DD section Section A task :a1, 2014-01-01, 30d Another task :after a1 , 20d section Another Task in sec :2014-01-12 , 12d another task : 24d

Class Diagrams

​```mermaid
 classDiagram
      Animal <|-- Duck
      Animal <|-- Fish
      Animal <|-- Zebra
      Animal : +int age
      Animal : +String gender
      Animal: +isMammal()
      Animal: +mate()
      class Duck{
          +String beakColor
          +swim()
          +quack()
      }
      class Fish{
          -int sizeInFeet
          -canEat()
      }
      class Zebra{
          +bool is_wild
          +run()
      }
​```
classDiagram Animal <|-- Duck Animal <|-- Fish Animal <|-- Zebra Animal : +int age Animal : +String gender Animal: +isMammal() Animal: +mate() class Duck{ +String beakColor +swim() +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() }

State Diagrams

​```mermaid
stateDiagram
    [*] --> Still
    Still --> [*]

    Still --> Moving
    Moving --> Still
    Moving --> Crash
    Crash --> [*]
​```
stateDiagram [*] --> Still Still --> [*] Still --> Moving Moving --> Still Moving --> Crash Crash --> [*]

Entity Relationship Diagrams

​```mermaid
erDiagram
    CUSTOMER ||--o{ ORDER : places
    ORDER ||--|{ LINE-ITEM : contains
    CUSTOMER }|..|{ DELIVERY-ADDRESS : uses 
​```
erDiagram CUSTOMER ||--o{ ORDER : places ORDER ||--|{ LINE-ITEM : contains CUSTOMER }|..|{ DELIVERY-ADDRESS : uses

本作品由 程小白 创作,采用 知识共享署名-相同方式共享 4.0 国际许可协议 进行许可,可自由转载、引用但需署名作者且注明文章出处。
原文地址:https://www.chengxiaobai.cn/record/markdown-concise-grammar-manual.html