简介
mos-plugin-package-json 是一个 mos 的插件，用于生成 Markdown 格式的文档，并从 package.json 中提取信息。
在前端开发中，我们通常会使用 npm 包管理器来管理项目依赖。同时，我们也需要将项目文档化以便于维护和分享。mos-plugin-package-json 就是为了简化这个过程而诞生的。
本文将详细介绍 mos-plugin-package-json 的使用方法，并通过实例演示如何将 package.json 中的信息转换为 Markdown 文档。
安装
首先，你需要安装 mos：
--- - -- ---
然后，在你的项目目录下安装 mos-plugin-package-json：
--- - ---------- -----------------------
配置
在项目根目录下创建 mos.yml 文件，添加以下内容：
-------- - -----------------------
使用
命令行方式
使用以下命令可以生成 Markdown 文档：
--- ---------
API 方式
你也可以在代码中使用 mos 的 API 来生成 Markdown 文档：
----- --- - --------------- ----- ----------- - -------------------------- ----------- - -- ------- ------------- ---------------- -- - -------------------- ---
其中，{packageJson} 会被替换成 package.json 中的内容。
实例
假设你的项目根目录下有以下的 package.json 文件：
-
------- -------------
---------- --------
-------------- -- ------ ---------
------- -----------
---------- -
------- ----- -------- -- ---- ----------- -- ---- --
--
----------- -
----------
---------
--
--------- ----- -----
---------- -----
-我们可以通过以下的 Markdown 模板来生成文档：
- ------ - ------------- -- -- -------- --- ------- ------ ------
使用
----- ----- - ------------------ -------------------
API
foo()
Return: `string`
Returns a string.
License
{license}
----------- ----------- ------ -------- --- ---------
最终的文档如下所示：
- ---------- - - ------ ------- -- -- -------- --- ------- ---------- ------
使用
----- ----- - ---------------------- -------------------
API
foo()
Return: string
Returns a string.
License
MIT
-- -- -- ------------------------- ----------- -------------- ------- -------- ------------------------------------------------ ----------------------------------------------------------- ---------- ---------------------------------------------------------------------------------------