npm 包 remark-wrap 使用教程

阅读时长 4 分钟读完

前言

在使用 Markdown 写作时,我们常常需要保持一定的格式和排版,这时候我们就需要使用一些工具帮助我们快速地对文本进行排版。而 npm 上的 remark-wrap 就是一款方便实用的自动换行工具。

在编写本文时,remark-wrap 的版本为 3.0.0。

安装

首先,我们需要使用 npm 安装 remark-wrap,可以通过以下命令进行安装:

安装完成后,我们就可以在项目中使用 remark-wrap 了。

使用

使用 remark-wrap 有两种方式:

  • 作为 remark 插件使用;
  • 使用其提供的命令行工具。

下面我们分别介绍一下这两种方式。

作为 remark 插件使用

我们可以在 remark 的配置文件中,通过设置 wrap 属性来使用 remark-wrap 插件。示例代码如下:

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

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

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

上述代码将 wrap 插件作为 remark 的一个插件使用,并通过 lineBreak 参数来指定要使用的换行方式,这里我们选用了 hard

使用命令行工具

除了在代码中使用之外,remark-wrap 也提供了一个命令行工具方便我们使用。

首先,我们需要全局安装 remark-wrap:

安装完成后,我们就可以使用 remark-wrap 命令了。例如,我们可以将 test.md 中的文本按照 hard 换行方式进行排版:

换行方式

remark-wrap 提供了三种换行方式:

  • hard:强制换行;
  • soft:软换行;
  • mixed:混合换行。

hard

hard 换行方式会在每一行的末尾添加一个换行符,从而强制换行。示例代码:

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

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

输出结果:

soft

hard 换行方式不同,soft 换行方式只在行末添加一个空格,从而软换行。示例代码:

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

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

输出结果:

mixed

mixed 换行方式是 hardsoft 两种方式的混合体。它会根据需要,在行末添加换行符或空格。示例代码:

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

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

输出结果:

总结

在本文中,我们介绍了 npm 上的自动换行工具 remark-wrap,并讲解了其使用方法以及提供的三种换行方式。通过这篇文章,相信大家已经掌握了如何使用 remark-wrap 进行快速的排版。

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

纠错
反馈