npm 包 @beligh/angular-markdown 使用教程

在前端开发中,使用 Markdown 方式写作已经成为一种越来越普遍的选择。然而,当它们需要被渲染为 HTML 时,就变得更加具有挑战性。这时,我们可以借助 npm 包 @beligh/angular-markdown,来使得 Markdown 内容能够在 Angular 中被渲染为 HTML。

1. 安装

在使用 @beligh/angular-markdown 时,需要先进行安装。可以使用 npm 的安装方式:

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

2. 引入

接下来,需要将该包引入到项目中。

在需要使用的 Angular 模块中引入:

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

-- ---

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

3. 使用

在项目中使用该包,可以通过下面的方式:

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

在上面的代码中,data 属性是必需的,并且需要传入对应的 Markdown 文本。变量 markdown 可以在某个组件类中定义。

举个栗子:

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

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

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

-- ----

- --
- --
--
-

以上的代码,即可将 Markdown 文本渲染成 HTML。

4. 增强渲染

@beligh/angular-markdown 还有一个增强版本,叫做 @beligh/angular-markdown-it。它使用 markdown-it 渲染器,且支持缩略语,注脚、定义列表、emoji、subscript 和 superscript 等等。

在使用之前,还是要先安装:

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

引入也很类似:

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

-- ---

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

使用方式和前一种方式类似,只不过需要使用另外一个组件:

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

同样地,也可以通过在某个组件类中定义 markdown 变量,来控制 Markdown 文本的内容:

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

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

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

-- ----

- --
- --
--
-

总结:

@beligh/angular-markdown 是一个轻量级的 Angular 组件,使得在 Angular 项目中渲染 Markdown 文本变得极为简单。我们可以适用它来展示格式化数据,丰富项目页面内容,还可以用来创建帮助文档或者发布博客等等。当我们需要增加对 Markdown 的解释能力时,可以使用增强后的 @beligh/angular-markdown-it。

代码示例:

https://stackblitz.com/edit/angular-grid-markdown-jev1yb?file=src/app/app.component.ts

参考资料:

  1. beligh/ngx-markdown
  2. beligh/angular-markdown-it

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


猜你喜欢

  • npm 包 cli-stylizer 使用教程

    什么是 cli-stylizer? cli-stylizer 是一个基于 Node.js 开发的命令行工具,它可以帮助前端开发者快速搭建命令行界面,添加样式和颜色,并且可以自定义样式。

    5 年前
  • npm 包 @types/color-convert 使用教程

    在前端开发中,我们常常需要处理颜色数值的转换与计算。而 @types/color-convert 就是一个非常方便的 npm 包,可以帮我们完成这些操作。本文将向大家介绍如何安装与使用 @types/...

    5 年前
  • npm 包 loadsh 使用教程

    什么是 loadsh? loadsh 是一个 JavaScript 实用工具库,提供了很多函数式编程的方法,能够极大地提高前端开发效率和代码质量,减少代码量,让代码更简洁易懂。

    5 年前
  • npm 包 chai-json-equal 使用教程

    简介 chai-json-equal 是一个 npm 包,它提供了一组断言函数,用于比较两个 JSON 对象是否相等。这个包通常用于编写测试代码,确保生成的 JSON 对象符合预期。

    5 年前
  • npm 包 socketcan 使用教程

    引言 在前端开发中,我们常常需要使用 socket 进行网络通信。而 socketcan 是一个 npm 包,它可以帮助我们更方便地使用 CAN 总线通信。本文将详细介绍 socketcan 的使用方...

    5 年前
  • npm 包 @malvineous/gamearchive 使用教程

    背景 在前端开发中,有时需要对游戏数据进行操作和处理。而游戏数据存储在各种不同的档案中,这些档案的格式和结构也是各不相同。如果我们想对这些数据进行修改或提取,需要考虑不同档案格式的复杂性和不同的操作方...

    5 年前
  • NPM包@malvineous/record-io-buffer使用教程

    在前端开发中,经常需要使用诸如文件读写、网络请求等操作。@malvineous/record-io-buffer是一个npm包,它提供了一种能够简单地处理I/O流的方式。

    5 年前
  • npm 包 text-encoding-shim 使用教程

    在前端开发中,经常会遇到需要处理字符编码的情况。而在不同的浏览器上,支持的字符编码格式和支持程度也不尽相同,这就给前端开发带来了诸多的困扰。为了解决这个问题,在实际的开发中常常会使用一些工具库来帮助我...

    5 年前
  • NPM 包 SnappyJS 使用教程

    什么是 SnappyJS SnappyJS 是一个用于在浏览器中运行压缩图像的 JavaScript 库。它可用于压缩 PNG、JPEG 和 WebP 格式的图像文件,并提供了高效的压缩算法,可以快速...

    5 年前
  • npm 包 dnssd 使用教程

    前言 DNS-SD 即 DNS Service Discovery,是一种通过 DNS 查询方式服务发现协议。它的优点是使用 DNS 统一服务发现和命名,同时具有自动配置、灵活和编程友好的特点,从而为...

    5 年前
  • NPM 包 @canboat/pgns 使用教程

    前言 在现代的互联网开发中,很多项目都需要通过数据库来存储数据。PGN(Parameter Group Numbers)是一种专门用于航海设备和应用程序通信的标准数据格式。

    5 年前
  • npm 包 @babel/plugin-transform-object-super 使用教程

    在 JavaScript 中,我们经常需要使用父类中的方法或属性。通常情况下,使用 super 关键字就可以实现我们想要的效果。但是在某些情况下,当我们使用 super 关键字时,系统可能会提示出错信...

    5 年前
  • npm 包 @babel/helper-member-expression-to-functions 使用教程

    随着 JavaScript 语言的发展和应用场景的不断扩大,其语言标准在不断更新和完善,使得开发人员需要不断更新自己的技能来适应新的变化。其中一个重要的技能就是使用 Babel 等工具来处理 Java...

    5 年前
  • npm 包 @rtsao/plugin-proposal-class-properties 使用教程

    在前端开发中,有许多工具和库可以帮助我们提升开发效率和代码质量。其中,npm 是我们常用的包管理工具之一。本文将介绍一个 npm 包 @rtsao/plugin-proposal-class-prop...

    5 年前
  • npm 包 @babel/plugin-transform-property-mutators 使用教程

    @babel/plugin-transform-property-mutators 是一个 Babel 插件,用于将一种更简单的语法转换为经过优化的 JavaScript 代码。

    5 年前
  • npm 包 @msokk/babel-plugin-styled-components 使用教程

    前言 在 React 项目中,经常会使用 styled-components 插件来管理样式。但是,在使用 styled-components 插件时,如果样式过多,会导致代码量过大,不利于代码的维护...

    5 年前
  • npm 包 @instructure/console 使用教程

    前言 npm 是 Node.js 的生态系统中用于管理包依赖的工具,我们在前端开发过程中使用 npm 经常会引用一些第三方依赖包来方便我们开发工作。其中 @instructure/console 这个...

    5 年前
  • npm 包 @daybrush/babel-plugin-no-side-effect-class-properties 使用教程

    作为前端开发人员,我们经常需要使用 JavaScript 类来处理数据,创建 UI 组件和实现许多其他功能。然而,在处理类属性时,我们可能会遇到一些问题。类属性通常会在实例化后被初始化,并且在每个实例...

    5 年前
  • npm 包 @babel/plugin-transform-template-literals 使用教程

    在前端开发过程中,经常需要使用模板字符串来拼接文本和变量。而在使用模板字符串的时候,有时候会遇到一些兼容性或者语法方面的问题,这时候就可以考虑使用 Babel 来转换模板字符串的语法,使得代码兼容性更...

    5 年前
  • npm 包 @bookingbug/app-manifest 使用教程

    什么是 @bookingbug/app-manifest? @bookingbug/app-manifest 是一个用于前端开发的 npm 包,它提供了一系列工具和方法来应用标准的 JavaScrip...

    5 年前

相关推荐

    暂无文章