npm 包 @iktakahiro/markdown-it-br 使用教程

阅读时长 3 分钟读完

简介

@iktakahiro/markdown-it-br 是一款基于 markdown-it 的插件,用于支持在 markdown 中使用 <br> 标签。

安装

使用 npm 进行安装:

使用

基本用法

首先,需要引入 markdown-it@iktakahiro/markdown-it-br

然后,需要将 @iktakahiro/markdown-it-br 插件加入到 markdown-it 中:

接下来可以开始使用 md,例如:

在上述代码中,<br> 标签会被渲染成 <br>

内联标签

除了 <br> 标签之外,还可以使用 \\ 在行末表示换行,例如:

在上述代码中,\\\\\n 会被渲染成 <br>

块级标签

默认情况下, <br> 标签会被渲染成内联标签。如果需要将其作为块级标签使用,可以使用 !br 语法:

在上述代码中,!br 会被渲染成 <br>

示例代码

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

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

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

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

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

指导意义

  • 掌握如何使用基于 markdown-it 的插件。
  • 熟练掌握在 markdown 中插入 <br> 标签的格式。
  • 了解如何使用插件中提供的高级用法,例如将 <br> 渲染为块级标签。

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

纠错
反馈