什么是 protagonist？
protagonist 是一种用于解析 API 设计文档的工具，它可以将 Markdown 格式的文档转换成 JSON 格式，使开发者能够通过编程来使用 API 文档。
如何安装 protagonist？
可以使用以下命令来安装 protagonist：
npm install -g protagonist
如何使用 protagonist？
1. 创建 Markdown 文档
首先，需要创建一个 Markdown 格式的 API 设计文档，例如：
-- -------------------- ---- ------- - --- -- -- ------ --- --- --------- ---- -------- - ---- --------- - ---- --- - -- - ---- --- ------ - ---
2. 使用 protagonist 解析文档
使用以下命令将 Markdown 文档转换为 JSON 格式：
protagonist <你的文档>.md -o <输出文件>.json
例如：
protagonist api.md -o api.json
此时就会生成一个名为 api.json 的 JSON 文件，其中就包含了 API 文档的内容。
3. 使用 JSON 数据
现在可以使用 Node.js 等编程语言将 JSON 数据读入内存中，以操作其中的内容。例如，在 Node.js 中，可以使用以下代码将 JSON 文件读入内存中：
const fs = require('fs');
fs.readFile('api.json', 'utf8', function (err, data) {
if (err) throw err;
const api = JSON.parse(data);
console.log(api);
});这里将读取 api.json 文件，并使用 JSON.parse() 方法将其转换为 JavaScript 对象，并输出到控制台。
总结
通过本文的介绍，您已经学会了如何使用 npm 包 protagonist 从 Markdown 格式的 API 设计文档中提取信息，以及如何使用读取 JSON 文件的方式操作其中的内容。这将大大提高 API 文档管理的效率和准确性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedabc4b5cbfe1ea061083f