npm 包 kmd 使用教程

阅读时长 3 分钟读完

简介

kmd 是一个用于字符串转换的 npm 包,可以将普通字符串转换为 markdown 格式,方便在前端页面展示富文本。

安装

使用 npm 包管理器,在终端中输入以下命令进行安装:

使用

将字符串转换为 markdown 格式

在项目中引入 kmd 并使用 convertToMarkdown 方法将字符串转换为 markdown 格式。

转换为指定标签

可以通过传递第二个参数将转换后的 markdown 文本替换为指定标签,具体的标签可以参考 markdown-it 文档。

使用自定义解析器

可以通过传递第三个参数指定自定义解析器的配置,格式与 markdown-it 相同。下面示例中将链接转换为 <a> 标签。

-- -------------------- ---- -------
------ - ----------------- - ---- ------
------ ---------- ---- --------------

----- ---- - ----- -- - -----------------------------
----- -- - --- -------------
--------------------------- - -------- ---- -------- ---- ----- -- -
  --------------- - ----
  --------------------------------- -----------
  ------------------------------ --------- --------------
  ------ ------------------------ ---- ---------
--
----- -------- - ----------------------- --- ----

----------------------
-- ------- -- - -- ------------------------- --------------- ------------- ---------------------

总结

通过 kmd 包,我们可以方便地将普通字符串转换为 markdown 格式,从而应用在前端富文本展示上。同时,我们也可以使用自定义解析器,对 markdown 内容进行更加灵活的转换。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/74797

纠错
反馈