npm 包 @gerhobbelt/markdown-it-attrs 使用教程

简介

@gerhobbelt/markdown-it-attrs 是一个 Node.js 包,它是 markdown-it 的插件之一,用于解析 Markdown 文章中的 HTML 标签,并支持为标签添加自定义属性。使用该插件可以简化在 Markdown 编辑器中手动添加 HTML 标签及其属性的工作,也方便在编辑器中生成可以为标签添加自定义属性的 Markdown 文本。

安装

确保在本地电脑上已经安装了 Node.js,然后在项目目录下使用 npm 命令进行安装:

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

在项目中使用

在项目中使用该插件,需要先加载 markdown-it,然后再加上该插件:

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

现在,你可以在 Markdown 文本中使用 HTML 标签及其自定义属性了。

示例

- ----- -----

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

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

在解析后,该 Markdown 文本将变成以下 HTML 代码:

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

如上所示,在 div 标签中加入了 class 和自定义属性 data-foo

属性的添加方式

为标签添加属性的方式是在标签后面加上一对大括号,然后在大括号中用逗号分隔每个属性。例如,下面的代码:

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

在 Markdown 中的写法如下:

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

注意,为了在属性值中使用逗号,请使用双引号或单引号包住属性值。

结语

@gerhobbelt/markdown-it-attrs 简化了为 Markdown 中的 HTML 标签添加自定义属性的过程。该插件方便了开发人员的操作,也加速了 Markdown 内容的编辑。希望这篇教程对大家有所帮助。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5f02c870403f2923b035bd73


猜你喜欢

相关推荐

    暂无文章