zc-marked 是一个简便易用、高度可配置的 Markdown 解析器,它可以在前端环境下使用。该包使用的是 marked,是一个高效的 Markdown 解析器。
安装
使用 npm 安装 zc-marked:
npm install zc-marked --save
基本用法
zc-marked 最基本的用法是将一个 Markdown 字符串转换为一个 HTML 字符串:
const zcMarked = require('zc-marked'); const markdown = '# Hello, world!'; const result = zcMarked(markdown); console.log(result); // <h1>Hello, world!</h1>
高级用法
渲染选项
zc-marked 的渲染行为高度可配置。可以自定义 marked 的渲染行为,下面是一个例子:
-- -------------------- ---- ------- ----- -------- - --------------------- ----- -------- - --------- ----- -------- - --- -------------------- ------------- - ------ --------- -- - ------ ----- ----------------------- --------------------------------------------------- -- ----- ------ - ------------------ - --------- -------- --- -------------------- -- ------------------------
上述例子是将 Markdown 中的代码块添加语法高亮效果。
插件
zc-marked 支持插件功能,你可以在插件中添加自定义的渲染行为或者语法分析行为。使用插件的方法:
-- -------------------- ---- ------- ----- -------- - --------------------- ----- -------- - ----------------------- ----------------------- ----- -------- - -- ------ -------- ----- ------ - ------------------- --------------------
示例代码
代码块添加语法高亮效果
-- -------------------- ---- ------- --------- ----- ------ ------ ---------------- --------------- ----- ---------------- -------------------------------------------- ------ ---------------- ------------- - -------------- ------ - ------------------------- ----------------------- - ------ -------- ------------ - --- ------- -- -- ----- ------------ --------- ------- ------- ------ ------- ------ ---------- ---------- ---- ----------- ----- ------------- ------- ------------ ---- ---------- ------- ------------ ---- ----------- -------- -------------- -- ------------ -- --------- -- ---------------- ----- ------------- ----- ------------ ----- -------- ----- - -------- ------- ------ ------------- ------------ ---- -------------------- ------- -------------------------------------------------------------------------------------------------------- ------- -------------------------------------------------------- -------- ----- ------------ - --------------------- ---- - --------------------------------- ------------------ ----- -------- - --- -------------------- ------------- - ------ --------- -- - ----- ----- - ------------- ----- ---- - --------------------- -------------------------- ---------- ------ ----- ----------------------- --------------------------------------------------- -- ----- -------- - ------------------------------------ ------------------ - ---------------------- - --------- -------- --- --------- ------- -------
插件示例
my-plugin.js 文件:
-- -------------------- ---- ------- ----- -------- - --------------------- -------- ------------ -------- - ------------------------------ - -------- ---- -------- ---- --------- -- - ------ -------- -- - ------ ----- ------------- - ------------------------------------ -------- ----- - - -------------- - ---------
使用 my-plugin.js 文件:
-- -------------------- ---- ------- ----- -------- - --------------------- ----- -------- - ----------------------- ----------------------- ----- -------- - ------------------ ------------- ----- ------ - ------------------- -------------------- -- ------- -- - ------ ----- ---------------------- ------------------------------ ---------------------
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600551cf81e8991b448cf349