npm 包 @juexro/markdown2html 使用教程-JavaScript中文网-JavaScript教程资源分享门户

在现代 Web 开发中，使用 Markdown 格式编写文章已成为主流。但是，在一些场景下，我们需要将 Markdown 转化为 HTML 格式，以实现更加高级的排版需求。

为了解决这个问题，我们可以使用 @juexro/markdown2html，一个快速的 Markdown 转化为 HTML 的 npm 包。本文将详细介绍如何使用该 npm 包。

安装

在使用 @juexro/markdown2html 之前，我们需要先在本地安装。在命令行中输入下面的命令即可：

npm install @juexro/markdown2html --save

使用方法

转化单个 Markdown 到 HTML

我们可以在 Node.js 中使用 @juexro/markdown2html。下面是示例代码：

const markdown2html = require('@juexro/markdown2html');
let html = markdown2html('# Hello World');
console.log(html);

这将输出：

<h1>Hello World</h1>

转化多个 Markdown 到 HTML

如果我们需要同时将多个 Markdown 文件转化为 HTML，可以使用以下代码：

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

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

这将把目录 ./markdown/ 中所有 Markdown 文件都转化为 HTML，并且在控制台中输出转化后的 HTML。

定义选项

我们可以通过配置选项来自定义转化出来的 HTML。@juexro/markdown2html 支持以下选项：

headerIds：是否在标题中使用 id。默认为 true。
ghCodeBlocks：是否在代码块中进行缩进和反引号这样的语言凸显。默认为 true。
taskLists：是否支持任务列表。默认为 true。
simpleLineBreaks：是否将单个换行符转换为 <br> 标签。默认为 false。
strikethrough：是否支持删除线。默认为 true。
tables：是否支持表格。默认为 true。
gfm：是否启用 GitHub Flavored Markdown。默认为 true。

我们可以在转化 Markdown 为 HTML 的时候，通过传递一个选项对象来指定选项。例如：

const markdown2html = require('@juexro/markdown2html');
let options = {
  headerIds: false,
  taskLists: false
}
let html = markdown2html('# Hello World\n- [ ] task', options);
console.log(html);

这将输出：

<h1>Hello World</h1>
<p>- [ ] task</p>

总结

在本文中，我们介绍了 @juexro/markdown2html 的用法。通过该 npm 包，我们可以快速将 Markdown 内容转化为 HTML，并且支持自定义选项。希望本文能对你有所帮助。

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