The documentation is a work in progress, and English edition is just an empty shell for now. I will translate it when Chinese edition has done.
getHeadingRegExp(min?, max?, flags?)
v1.2.2 +
- 参数:
min = 1:最小标题层级。max = 6:最大标题层级。flags?: string:正则表达式的flags。
- 返回值:
RegExp
获取匹配 Markdown 标题语法的正则表达式。
getLinkRegExp(startWithSlash?, isImg?, isLine?, flags?)
v1.2.2 +
- 参数:
startWithSlash = false:链接地址是否以/开头。isImg = false:是否为图片链接。isLine = false:是否为行匹配。flags?: string:正则表达式的flags。
- 返回值:
RegExp
获取匹配 Markdown 链接语法的正则表达式。
getWrapRegExp(left, right?, flags?)
v1.2.2 +
- 参数:
left: string:左侧字符串。right = left:右侧字符串。flags?: string:正则表达式的flags。
- 返回值:
RegExp
获取匹配被指定字符串包围的字符串的正则表达式。
getMarkRegExp(mark, isLine?, flags?)
v1.2.2 +
- 参数:
mark: string:标记字符串。isLine = true:是否为行匹配。flags = 'im':正则表达式的flags。
- 返回值:
RegExp
获取匹配标记语法的正则表达式。
getSnippetRegExp(flags?)
v1.2.2 +
- 参数:
flags?: string:正则表达式的flags。
- 返回值:
RegExp
获取匹配嵌入链接语法的正则表达式。
getAnchorRegExp(isLine?, min?, max?, flags?)
v1.2.2 +
- 参数:
isLine = true:是否为行匹配。min = 2:最小 Hash 锚点层级。max = 6:最大 Hash 锚点层级。flags?: string:正则表达式的flags。
- 返回值:
RegExp
获取匹配 Hash 锚点语法的正则表达式。
getParamRegExp(flags?)
v1.2.6 +
- 参数:
flags = 'g':正则表达式的flags。
- 返回值:
RegExp
获取匹配嵌入参数语法的正则表达式。

- This page is open source, improve it