npm 包 js-namumark 使用教程

阅读时长 4 分钟读完

前言

js-namumark 是一个可用于浏览器和 node.js 环境的 markdown 渲染器,设计用于韩国南都的 wiki,支持复杂的 wiki 语法及其扩展。

本文将介绍如何使用 js-namumark,包括如何安装、使用及其一些高级功能,并提供示例代码。

安装

js-namumark 可以通过 npm 包管理器进行安装:

或者通过 yarn 安装:

基本用法

js-namumark 支持在浏览器和 node.js 环境中使用,它提供了一个函数 render 可以将 markdown 渲染成 HTML 格式。

在浏览器环境中,可以通过以下方式使用:

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

在 node.js 环境中,可以通过以下方式使用:

上述代码将输出 <p><em>Hello, world!</em></p>

高级用法

自定义渲染器

js-namumark 允许用户自定义渲染器,可以通过在选项中设置 renderer 属性来实现。

以下代码演示如何定义一个简单的渲染器:

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

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

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

在上面的代码中,我们定义了一个渲染器,它将将文本节点用 span 标签包起来,并添加红色样式。输出 HTML 为 <p><span style="color: red;">This is a test.</span></p>

扩展语法

js-namumark 支持扩展语法,可以通过在选项中设置 syntax 属性来添加扩展。

以下代码演示如何在 js-namumark 中添加扩展:

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

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

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

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

在上面的代码中,我们添加了一个扩展语法 {{no|text}},它将用 span 标签包裹 text,同时添加蓝色样式。输出 HTML 为 <p>This is <span style="color: blue;">a test</span>.</p>

结语

js-namumark 是一个功能强大的 markdown 渲染器,它支持扩展语法和自定义渲染器,可以满足大部分应用场景的需要。希望本文可以帮助大家更好地使用 js-namumark。

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

纠错
反馈