引言
在前端开发中，文档是必不可少的，它可以让我们更好地理解代码、规范开发流程，提高团队合作效率。而 npm 包 @metarhia/doc 就是一个强大的文档生成工具，可以帮助我们生成规范的文档。
安装
安装 @metarhia/doc 可以通过 npm 安装，打开终端输入以下命令：
npm install @metarhia/doc
使用
@metarhia/doc 的使用非常简单，只需要在命令行中输入以下命令即可生成文档：
doc <entry> [-o|--output <dir>] [-p|--public <dir>] [--clean]
其中，<entry> 为文档的入口文件路径，可以是单个文件或文件夹，-o 参数指定文档输出目录，-p 参数指定文档资产目录，--clean 参数表示在生成文档之前先清空输出目录。
除了命令行方式之外，还可以通过 JavaScript API 方式生成文档，示例如下：
-- -------------------- ---- ------- ----- --- - ------------------------- ----------- ------ ----------- ------- ------- ------- --------- ------ ---- -- -------- -- ----------------------- ------------ -- --------------------------------
配置
@metarhia/doc 提供了丰富的配置项，可以让我们生成更加符合需求的文档。下面是一些常用的配置项：
input: 文档的入口文件路径，可以是单个文件或文件夹。output: 文档输出目录，默认为当前目录下的docs目录。public: 文档资产目录，默认为当前目录下的public目录，包含了图片、样式等文件。clean: 在生成文档之前是否清空输出目录，默认为false。recursive: 是否递归查找输入目录下的文件，默认为true。title: 文档标题。subtitle: 文档副标题。footer: 文档页脚。description: 文档描述。logo: 文档 Logo。favicon: 文档标签栏图标。language: 文档语言，默认为英语（'en'），还支持中文（'zh'）、俄语（'ru'）等多种语言。template: 自定义文档模板路径。
示例
以下是一个简单的示例，我们将使用 @metarhia/doc 创建一个文档。首先，我们创建一个文件夹 my-doc，用来存放文档。
然后，在 my-doc 目录下创建一个入口文件 index.js，输入以下内容：
-- -------------------- ---- ------- --- - ----- ------ - - ------ -------- ---- - -- - -------- -------- - ---- -- -------- ----------- - ------ ------- ---------- - ----------------------------
然后，在命令行中进入 my-doc 目录，执行以下命令生成文档：
doc index.js
此时，my-doc 目录下会生成一个 docs 目录，里面包含了生成的文档。打开 index.html 文件就可以看到生成的文档了。
结语
@metarhia/doc 是一个功能强大、配置灵活的文档生成工具，它可以帮助我们快速地生成高质量的文档。希望本篇教程对你有所帮助，谢谢阅读！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedb83ab5cbfe1ea061180b