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.
markdownIt
v1.2.0 +
- 类型：
MarkdownIt
markdownIt 对象。
parseMD(data)
v1.2.0 +
- 参数：
data: string：Markdown 字符串。
- 返回值：
Token[]
解析 Markdown 字符串为 markdownIt 的 Token 列表。
renderMD(data, replaceMark?)
v1.2.4 +
- 参数：
data: string：Markdown 字符串。replaceMark = true：是否替换标记。
- 返回值：
string
将 Markdown 字符串渲染为 HTML。
updateAsyncScript(asyncResult)
v1.2.9 +
- 参数：
asyncResult: TAsyncResult：异步结果。
- 返回值：
boolean
用异步结果更新页面。如果没找到元素则返回 false。
updateInlineScript(path, title, data, isSnippet?, asyncResults?)
v1.2.9 +
- 参数：
- 返回值：
string
执行 Markdown 字符串中使用的行内脚本，返回更新后的字符串。
updateSnippet(data, updatedPaths, asyncResults?)
v1.2.9 +
- 参数：
data: string：Markdown 字符串。updatedPaths: string[]：已经更新过的文件路径列表。asyncResults?: TAsyncResult[]：异步行内脚本的执行结果列表。
- 返回值：
Promise<string>
合并 Markdown 字符串中使用嵌入链接引用的文件，返回更新后的字符串。
updateList(data)
v1.2.0 +
- 参数：
data: string：Markdown 字符串。
- 返回值：
Promise<string>
预处理 Markdown 字符串中使用的 [list] 标记，返回更新后的字符串。
preprocessSearchPage(data)
v1.2.0 +
- 参数：
data: string：Markdown 字符串。
- 返回值：
string
预处理 Markdown 字符串中使用的搜索页相关标记，返回更新后的字符串。
updateSearchPage(content)
v1.2.0 +
- 参数：
content: string：查询内容。
- 返回值：
Promise<void>
用查询内容更新搜索页。
updateHighlight()
v1.2.0 +
- 参数：无
- 返回值：
Promise<void>
高亮代码块。
updateDom()
v1.2.0 +
- 参数：无
- 返回值：
Promise<void>
用一堆函数更新 document。
- This page is open source, improve it