简介
md-convert-json 是一个将 Markdown 格式转化为 JSON 格式的 npm 包，使用该包可以方便地将 Markdown 格式的文档转化为各种格式的文档。本文将介绍该包的基本使用方法以及相关注意事项。
安装
安装 md-convert-json，只需要在命令行中运行以下命令即可：
npm install md-convert-json
使用
- 在需要将 Markdown 文件转化为 JSON 格式的文件中引入
md-convert-json。
const mdConvertJson = require('md-convert-json');- 调用
mdConvertJson函数，返回转化后的 JSON 格式的文档。
const jsonDocument = mdConvertJson(markdownString, configurationObject);
其中，参数 markdownString 为需要转化的 Markdown 文本，参数 configurationObject 可以设置转化的配置，包括输出格式、标题等。
- 将生成的 JSON 文档存储到文件中。
fs.writeFileSync(outputPath, jsonDocument);
配置
md-convert-json 可以通过配置对象 configurationObject 来设置转化的方式，以下是一些常用的配置项：
headingLevel: 可以设置输出的标题的最低级别，比如2将只输出二级标题及以上的内容；outputFormat: 可以设置输出的格式，包括html、latex、man、markdown、rst、text和xml；pandocPath: 可以设置 pandoc 的路径，如果不设置则默认使用系统环境变量 PATH 中的 pandoc 路径。
示例
假设我有一个格式为 example.md 的 Markdown 文件：
-- -------------------- ---- ------- - -- - -------- -- -- --- -------- --- -- --- -------- --- -- --- --------
下面的代码演示了如何将 example.md 文件转化为 JSON 格式并输出到路径为 example.json 的文件中：
const fs = require('fs');
const mdConvertJson = require('md-convert-json');
const markdownString = fs.readFileSync('example.md', 'utf-8');
const jsonDocument = mdConvertJson(markdownString, {headingLevel: 2});
fs.writeFileSync('example.json', JSON.stringify(jsonDocument, null, 2));运行以上代码，得到输出文件 example.json 的内容如下：
-- -------------------- ---- -------
-
----------- ---
---------- -
-
------- --- ---
-------- --
---------- -
-
------- -----------
-------- --
---------- --
--
-
------- --- -----
-------- --
---------- -
-
------- -----------
-------- --
---------- --
-
-
-
-
-
-
-因为设置了 headingLevel: 2，所以只有一级和二级标题及其以下的内容被转化为了 JSON 格式。
结语
md-convert-json 是一个功能强大的 Markdown 转换工具，使用这个工具可以轻松的进行 Markdown 格式转换。如果你需要将 Markdown 文档转为其他格式的文档，不妨试试这个工具。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055eaf81e8991b448dc408