npm 包 nxus-md-renderer 使用教程-JavaScript中文网-JavaScript教程资源分享门户

npm 包 nxus-md-renderer 使用教程

AI 编程助手，豆包旗下的编程助手，提供智能补全、智能预测、智能问答等能力，节省开发时间，释放脑海中的创造力，支持 VSCode，点击体验 AI

前言

在日常的前端开发中，我们通常会使用 markdown 进行文档编写和内容展示，而 nxus-md-renderer 就是一个方便我们在 Node.js 环境下渲染和展示 markdown 的 npm 包。本文将介绍如何使用该 npm 包进行 markdown 的渲染和展示。

安装

使用 npm 命令进行安装：

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

使用

使用 nxus-md-renderer 进行 markdown 渲染有两种方式，一种是采用静态文件的方式，另一种是采用动态字符串的方式。

静态文件

创建一个 md 文件，命名为 test.md 。在该文件中编写 markdown 语法，如下所示：

- ----

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

-- ----

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

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

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

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

使用 renderFile 方法渲染 md 文件，返回一个 promise 对象，最终得到渲染后的 html 字符串。

动态字符串

直接使用 nxus-md-renderer 进行字符串渲染也是可行的，例如：

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

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

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

-- ----

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

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

使用 render 方法渲染字符串，同样返回一个 promise 对象，最终得到渲染后的 html 字符串。

配置

nxus-md-renderer 支持一些配置项参数：

basePath: string: 基础路径，默认为空字符串。
toc: boolean: 是否显示目录，默认为 true。
breaks: boolean: 是否换行，默认为 false。
html: boolean: 是否渲染 html 标签，默认为 false。
highlight: function: 代码高亮函数，默认为 require('highlight.js').highlightAuto。

例如，如果不想显示目录，则可以使用：

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

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

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

示例

完整的源代码示例如下：

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

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

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

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

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

-- ----

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

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

总结

通过本文的介绍，相信大家已经了解了如何使用 npm 包 nxus-md-renderer 进行 markdown 渲染和展示，并对其一些常用的配置有了一定的了解。在日常开发中，掌握这种技能会有很大的帮助，希望本文能在您的学习和实践中起到指导作用。

来源：JavaScript中文网，转载请联系管理员！本文地址：https://www.javascriptcn.com/post/60066f963d1de16d83a66d58