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

简介

@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


猜你喜欢

  • npm 包 decoder.flow 使用教程

    介绍 decoder.flow 是一个基于 TypeScript 实现的数据解码器。它可以帮助我们将从服务器接收到的 JSON 数据转化为 TypeScript 类的实例。

    3 年前
  • npm 包 typing-function 使用教程

    前言 在前端开发中,我们通常需要手动添加类型注解,以便代码在编译期间能够发现类型相关的错误。这使得代码更健壮、更易于维护,但是也给我们的开发带来了一些麻烦。typing-function 就是一个解决...

    3 年前
  • npm 包 yta 使用教程

    在前端开发中,使用 npm 包是很常见的。而其中一个常用的 npm 包 yta,它可以用来计算 YouTube 视频的元数据,比如视频的标题、描述、发布时间、评论数、评分等等。

    3 年前
  • npm 包 vorpal2 使用教程

    什么是 vorpal2 vorpal2 是一个用于构建命令行程序的 Node.js 包,可以快速、简便地创建交互式命令行界面(CLI)。它是 vorpal 的改进版本,更加灵活,同时也包含了许多实用的...

    3 年前
  • npm 包 ficons-webfont-generator 使用教程

    在 Web 开发中,图标已成为网页设计不可或缺的一部分。为了方便地制作和使用图标,我们可以使用 npm 包 ficons-webfont-generator。它可以将 SVG 图标转换为 Webfon...

    3 年前
  • npm 包 react-simdux 使用教程

    前言 在前端开发中,我们常常需要使用状态管理工具,以便更好地管理数据和提高应用性能。React作为一种流行的前端框架,提供了一种称为Redux的状态管理工具。而在Redux之外,还有一些轻量级的状态管...

    3 年前
  • npm 包 ember-chat 使用教程

    简介 ember-chat 是一款基于 Ember.js 和 Firebase 开发的聊天应用模板,可用于快速搭建自己的即时通讯系统。通过使用 ember-chat,用户可以轻松地实现聊天记录存储、消...

    3 年前
  • npm 包 cryptobase 使用教程

    前言 在前端开发中,数据的加密和解密是一个重要的问题。过去,为了实现加密和解密操作,我们需要自己编写复杂的算法,这不仅浪费时间,而且容易出错。 现在,借助社区贡献的 npm 包 cryptobase,...

    3 年前
  • npm包 import-css 使用教程

    什么是import-css import-css 是一个 npm 包,用于处理 css 的导入及传递。它可以将一个 css 文件中的样式导入到另一个 css 文件中,也可以将一个样式文件中的样式传递到...

    3 年前
  • npm 包 nlogn 使用教程

    在前端开发中,我们经常需要对数据进行排序、查找等操作。而复杂度最低且在大部分情况下表现良好的排序算法就是 nlogn 级别的排序算法。在 JavaScript 中,我们可以使用 nlogn 这个 np...

    3 年前
  • npm 包 jwks-db 使用教程

    在使用 OAuth2 和 OpenID Connect 时,我们通常需要使用公钥加密/验签,私钥解密/签名等操作,这些操作需要使用 JSON Web Key (JWK)访问。

    3 年前
  • npm包 homebridge-nest-cong使用教程

    前言 在现代的智能家居系统中,智能温控系统的作用越来越受到人们的关注。其中 Nest 温控系统是业内比较知名的一款产品,其提供了丰富的 API 接口用于开发者进行二次开发。

    3 年前
  • npm 包 homebridge-abode 使用教程

    homebridge-abode 是一个使用 Homebridge 接入 Abode 安保系统的 npm 包。本文将介绍如何使用 homebridge-abode,帮助读者快速实现接入 Abode 安...

    3 年前
  • npm 包 homebridge-hue-temperature 使用教程

    前言 Homebridge 是一个基于 Node.js 的开源智能家居服务,可以将不支持 HomeKit 的智能家居设备,通过 Homebridge 转换成支持 HomeKit 的设备。

    3 年前
  • npm 包 homebridge-servo-switch 使用教程

    前言:在家居智能化的大潮中,HomeKit 已然成为一个不可忽视的方案,而 HomeKit 的配件开发,尤其是面向一个特定蓝牙设备指定行为时,就需要 homebridge-Servo-Switch 这...

    3 年前
  • npm包iopd-rpc使用教程

    IOPD-RPC是一个使用Node.js编写的npm包,提供了IOPD命令行界面的客户端功能。这个包简化了IOPD的RPC接口授权和Json-RPC通信。 在这篇文章中,我们将会介绍如何使用npm包i...

    3 年前
  • npm 包 rnkit-splash-screen 使用教程

    rnkit-splash-screen 是一个 React Native 应用程序的开屏(启动画面)组件,可以轻松地为你的应用程序添加引人注目的启动画面。本文将向您介绍如何使用 npm 包 rnkit...

    3 年前
  • npm 包 teth-todo-actions-and-reducers 使用教程

    简介 teth-todo-actions-and-reducers 是一个基于 Redux 的 npm 包,旨在帮助前端开发者快速实现 To-do List 功能。

    3 年前
  • npm包babel-plugin-dotjs使用教程

    概述 babel-plugin-dotjs是一个用于JavaScript项目的Babel插件。它可以将JS文件的.dot语法转换为JS。.dot是一种类似于Mustache的语法,它可以让你在JS中以...

    3 年前
  • npm 包 grapesjs-aviary 使用教程

    介绍 Grapesjs 是一个使用纯 Javascript 和 CSS 构建的开源网页编辑器,可以让用户通过拖拽、放置的方式来创建网页。而 grapesjs-aviary 是 grapesjs 的一个...

    3 年前

相关推荐

    暂无文章