npm 包 markdown-magic 使用教程-JavaScript中文网-JavaScript教程资源分享门户

简介

markdown-magic 是一个基于 Node.js 的 npm 包，它可以帮助开发者在 Markdown 文件中插入动态生成的内容，如代码块、表格等等。通过编写自定义的插件脚本，我们可以在构建过程中自动生成文档、更新版本号、从 API 中提取数据等等。

安装和配置

首先，我们需要确保环境中已经安装了 Node.js 和 npm 包管理器。然后，我们可以通过以下命令来安装 markdown-magic：

npm install --save-dev markdown-magic

接下来，在项目的根目录下创建一个名为 .magic.md 的文件，并将以下内容添加到文件中：

<!-- AUTO-GENERATED-CONTENT:START (INSERT MAGIC SCRIPT) -->
<!-- AUTO-GENERATED-CONTENT:END -->

这段注释是 markdown-magic 插入内容的标志，我们将在后面的步骤中用到它。现在，让我们来编写我们自己的插件脚本。

编写插件脚本

在项目中创建一个名为 magic-plugin.js 的文件，并将以下内容添加到文件中：

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

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

这个插件会读取 example.txt 文件的内容，并将其插入到 Markdown 文件中。现在，我们需要将插件脚本关联到 .magic.md 文件中。

关联插件脚本

打开 .magic.md 文件，并将以下内容添加到文件中：

<!-- AUTO-GENERATED-CONTENT:START (PLUGIN) -->
<!-- AUTO-GENERATED-CONTENT:END -->

接下来，在项目根目录下创建一个名为 magic.config.js 的文件，并将以下内容添加到文件中：

const path = require('path');

module.exports = {
  transforms: {
    PLUGIN: path.join(__dirname, 'magic-plugin.js'),
  },
};

这个配置文件告诉 markdown-magic 使用 magic-plugin.js 插件来处理 .magic.md 文件中的  和  标记之间的内容。

运行 markdown-magic

最后一步是运行 markdown-magic 命令来生成 Markdown 文件。我们可以通过以下命令来运行它：

npx markdown-magic README.md

这个命令会使用 README.md 文件作为输入文件，并自动更新文件中的  和  标记之间的内容。

示例代码

我们来看一个完整的示例代码：

.magic.md 文件

# My Project

<!-- AUTO-GENERATED-CONTENT:START (INSERT MAGIC SCRIPT) -->
<!-- AUTO-GENERATED-CONTENT:END -->

## License

MIT

magic-plugin.js 文件

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

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

magic.config.js 文件

const path = require('path');

module.exports = {
  transforms: {
    PLUGIN: path.join(__dirname, 'magic-plugin.js'),
  },
};

运行 markdown-magic 命令

npx markdown-magic README.md

这个示例代码会将 example.txt 文件的内容插入到 README.md 文件中的  和  标记之间。

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