npm 包 assemble-remarkable 使用教程

概述

assemble-remarkable 是一个将 Remarkable 和 Assemble 结合在一起的 npm 包，可用于编译 Markdown 文件到 HTML。由于 Assemble 已经停止维护，assemble-remarkable 仅适用于旧版本 Assemble，建议在新项目中使用其他现代的静态网站生成器，例如 Hugo 或 Gatsby。

安装

npm install assemble-remarkable --save-dev

使用

配置

首先在 assemblefile.js 中引入 assemble-remarkable：

var ar = require('assemble-remarkable');

然后在 Assemble 的配置对象中添加 render 方法，使用 ar 编译 Markdown 文件：

assemble.options = {
  render: function(str, options, fn) {
    var res = ar.render(str, options);
    fn(null, res);
  }
};

示例

创建一个名为 example.md 的 Markdown 文件：

## 标题
这是一个段落。

然后在 Assemble 的模板中调用 Markdown 文件：

{{md 'example.md'}}

最后编译模板文件：

assemble

在输出文件中将看到已经将 Markdown 编译为 HTML：

<h2>标题</h2>
<p>这是一个段落。</p>

配置选项

assemble-remarkable 可以接受多个选项，这些选项会被传递给 Remarkable：

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

以下是一些常用的选项：

• html: 是否允许在 Markdown 中使用 HTML 标签，默认为 false
• xhtmlOut: 是否使用 XHTML 输出格式，默认为 false
• breaks: 是否将换行符转换为 <br> 标签，默认为 false
• linkify: 是否将文本中的 URL 和 email 自动转换为链接，默认为 false
• typographer: 是否启用 Markdown 中的 typographer 功能，例如自动将普通引号替换为尖括号引号以及自动将破折号转换为 emdash 等，默认为 false

可用的选项列表请参阅 Remarkable 文档。

小结

assemble-remarkable 可以让开发者轻松地将 Markdown 转换为 HTML，尽管 Assemble 已经停止维护，但本文提供了一些适用于旧版本 Assemble 的示例代码，对于需要使用 Assemble 的团队来说可能仍然有用。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055c3481e8991b448d9d25