前言
最近使用 markdown-it 比较多,也开发了一些插件,在这个过程中对源码进行了研读,最终写了这篇文章。需要了解细节的读者可以自行阅读文档。
此文分为两个部分:原理剖析和原理应用(编写插件)。
markdown-it 原理
输入一串 markdown 代码,最后得到一串 html 代码,整体流程如下:
我们以一个简单的例子来解释整个流程:# 我是一个例子
-> <h1>我是一个例子</h1>
首先,它会被解析器拿到,经过各个解析规则处理后得到一个 token 流,接着这个 token 流被渲染器拿到,经过各个渲染规则处理后逐步拼接成一个 html 字符串。
解析器
markdown-it 内置了七个核心规则,在上图我对解析规则使用了虚线,因为它们是可以被启用/禁用的。我们这篇文章只来聊聊最核心的两个规则:block 和 inline。
规范指出:
我们可以将一篇 Markdown 文档视为一系列块,块是一种结构化的元素,如段落,块引用,列表,标题,规则和代码块。一些块(如块引号和列表项)可以包含其他块