在前端开发中，我们通常会写很多文档来记录代码的使用方法和 API 文档。而这些文档中经常包含示例代码，为了方便维护和更新，我们可以使用 npm 包 update-markdown-usage 来自动更新示例代码部分。
安装
npm install -g update-markdown-usage
使用方法
命令行参数
update-markdown-usage <input> [options]
其中 <input> 是 Markdown 文件的路径。
可选的参数有：
-o, --output <path>：指定输出文件路径，如果不指定则将结果写回到原文件。-p, --package-dir <path>：指定项目根目录的路径，用于解析依赖包。默认值为当前工作目录。-c, --config <path>：指定配置文件的路径，用于配置需要更新的示例代码块的信息。默认值为.update_markdown_usage.json。
配置文件
在项目根目录下创建一个名为 .update_markdown_usage.json 的文件，用于配置需要更新的示例代码块的信息。
示例：
-- -------------------- ---- -------
-
--------------- -
-------- ----------
------------ ---------
--
----------- -
---------
--
----------------- -
---------------------
-
-其中 dependencies 字段用于指定项目依赖的包及其版本号，patterns 字段用于指定需要更新的 Markdown 文件匹配模式，ignorePatterns 字段则是忽略文件的匹配模式。
示例代码块
在 Markdown 文件中，示例代码块的语法如下：
```js
const foo = require('foo');
foo.bar();-- -------------------- ---- -------
-- ---- ------------------------------------ ----------------------------------
-- --
------- ----- ------------- ----------- --- ---
------
------ ----- ---- --------
---
- ------
-
- ------ -------- -----
- ------ ---------- - ------------ -------------
- ------ -------- ----------
--
-------- ------------- -
----- - -------- ---- - - ------
------ -
------- --------------- -----------------
------
---------
--
-
------ ------- -------我们可以在代码仓库中创建一个名为 .update_markdown_usage.json 的文件，内容如下：
-- -------------------- ---- -------
-
--------------- -
-------- ----------
------------ ---------
--
----------- -
---------
--
----------------- -
---------------------
-
-然后在 Markdown 文档中写入示例代码块：
## 使用 ```jsx import Button from './Button'; <Button variant="primary" text="Click me!" />
-- -------------------- ---- ------- -- ---------------------- -- -------------------------- ------------------------ ---- -------- ------- ----------- -- -- ------ ------ ----- ---- -------- ------ -------- ---- ------------ ------ ------ ---- ----------- ---------------- ------- ----------------- ----------- ---- --- ------------------------------- --
## 结论 使用 npm 包 `update-markdown-usage` 可以帮助我们在文档中自动更新示例代码部分的依赖包版本，避免因为依赖包升级而导致示例代码不可用的问题。同时，通过配置文件和命令行参数的设置，我们 > 来源：[JavaScript中文网](https://www.javascriptcn.com/post/45629) ，转载请注明来源 [https://www.javascriptcn.com/post/45629](https://www.javascriptcn.com/post/45629)