Typecho演示站

念念不忘,必有回响

  • 4
  • 文章数
  • 3
  • 分类数
  • 1
  • 评论数
标题

「 MarkdownParse插件功能展示 」

typecho_xin   |  2026年07月28日 作为 typecho-markdown 的开发者,收到很多关于 Markdown 解析库的使用问题。对于功能上的 bug 当...
内容

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

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

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

本插件符合 CommonMark 和 GFM(GitHub-Flavored Markdown)规范,开源免费,大家用的开心就行 😉。

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

本博客运行环境:

  • PHP - 8.4.23
  • Typecho - 1.3.0
  • MarkdownParse Plugin - 2.7.3

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

0.目录

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

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

示例:

[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. 插入图像

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

示例:


![浪浪山](https://img.szfx.top/typecho/content/langlangshan.webp)

浪浪山

图片延迟加载

支持浏览器原生的图片延迟加载,无 JavaScript 依赖,默认开启,参考文档:MDN-Lazy loading,现代浏览器基本都支持,详细见 Can I use

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.
$$

这也是一个公式块
$$
\begin{align*}
    \nabla \times \mathbf{B} - \frac{1}{c} \frac{\partial \mathbf{E}}{\partial t} &= \frac{4\pi}{c} \mathbf{J} \\
    \nabla \cdot \mathbf{E} &= 4\pi \rho \\
    \nabla \cdot \mathbf{B} &= 0 \\
    \nabla \times \mathbf{E} + \frac{1}{c} \frac{\partial \mathbf{B}}{\partial t} &= \mathbf{0}
\end{align*}
$$

这是一个行内公式:$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. $$

这也是一个公式块

$$ \begin{align*} \nabla \times \mathbf{B} - \frac{1}{c} \frac{\partial \mathbf{E}}{\partial t} &= \frac{4\pi}{c} \mathbf{J} \\ \nabla \cdot \mathbf{E} &= 4\pi \rho \\ \nabla \cdot \mathbf{B} &= 0 \\ \nabla \times \mathbf{E} + \frac{1}{c} \frac{\partial \mathbf{B}}{\partial t} &= \mathbf{0} \end{align*} $$

12. 注脚


Typecho Markdown 插件第一版本发布于 2017-12-02[^1]。

[^1]: 来源于插件更新记录:https://www.chengxiaobai.cn/php/markdown-parser-library.html

Typecho Markdown 插件第一版本发布于 2017-12-021

13. 文本高亮(2.0.0 及之后版本支持)

使用 == 包裹起来的文本会被高亮展示,无 JavaScript 依赖,默认开启,参考文档:MDN-Mark,现代浏览器基本都支持,详细见 Can I use


这句话里面==程小白==被高亮标记了。

这句话里面程小白被高亮标记了。

14. 任务列表(2.0.0 及之后版本支持)

任务列表展示,无 JavaScript 依赖,只读模式。


- [x] Typecho 最新版本插件系统适配
- [x] MarkdownParse 适配 GFM
- [ ] MarkdownParse 发布 2.0 版本
  • [x]  Typecho 最新版本插件系统适配
  • [x]  MarkdownParse 适配 GFM
  • [ ]  MarkdownParse 发布 2.0 版本

15. 外部链接(2.0.0 及之后版本支持)

内部链接:默认为博客域名,支持正则表达式 /(^|\.)example\.com$/,多个可以用英文逗号区隔

外部链接:非内部链接,接解析策略:默认在新窗口中打开,并加上 "noopener noreferrer" 属性。

原文链接:https://www.chengxiaobai.cn/record/markdown-concise-grammar-manual.html

评论