简介
npm-docs-readme 是一个方便的 npm 包，可以快速生成 npm 包的使用文档和 README。使用该包可以使开发者更加便捷地创建好看的 README 文档，同时展示出 npm 包的基本信息和使用方法，提高了 npm 包的可用性和易用性。
安装
使用 npm 包 npm-docs-readme，你需要先安装 node.js 和 npm，然后在命令行窗口中输入以下命令进行安装：
--- - ---------------
使用方法
npm-docs-readme 主要通过读取项目下的文件信息生成 README 文件。使用 npm-docs-readme 你只需要在项目根目录编写一个配置文件即可。配置文件需要指定 npm 包的基本信息，例如：
-
------- -----------------
-------------- ----- -- -- ---------
-当然，你也可以在配置文件中定义多个不同型号的 README 文件。示例代码如下：
-
------- -----------
-------------- ----- -- --------- -- -- ------ -------
---------- -
-
----- ---------
----------- ------------
--------- ------------
-------- --- ---- ---------
---------- ---------------------------
------- -
-------- --- ---- ---------
-------------- ----- -- -- ---- ---------
-
--
-
----- ---------------
----------- ------------------
--------- -----------------
-
-
-在配置文件中也支持一些全局变量，可以在 README 文件中使用。这些全局变量包括 name，description，version，author，license，repository，homepage。
示例代码
接下来，我们通过一个示例来演示 npm-docs-readme 的使用。假设你已经有一个简单的 npm 包，这个 npm 包包含一个 sum.js 文件，其中我们定义了一个 sum 函数。现在，我们想要生成一个漂亮的 README，来介绍 sum.js 的使用方法。
首先，我们需要在项目根目录下创建一个 .npm-docs-readme.json 的文件来作为配置文件。该文件的内容如下：
-
------- ---------
-------------- ----- -- - --- ------- --- ----------- --- -- --- ----------
---------- --------
--------- ----- ------
---------- ------
------------- -------------------------------------
----------- -------------------------------------
---------- -
-
----- ---------
----------- ------------
--------- ------------
-------- ---- -- --- --------
---------- ---------------------------
------- -
-------- ---- -- --- --------
-------------- ----- -- - --- ------- --- ----------- --- -- --- ----------
---------- ------ --- - ---------------------------------------------- ------ ------- --
-
-
-
-其中的 id、template、output、title、content、data 等属性的含义请参见前文。
然后，我们在项目根目录下创建一个 src 目录，并在该目录下新建 README.template.md 文件，文件的内容如下：
-- --- -- --- ------ -- --- ------- --- ---- ---- -- ------ --- ------ --- --- --- ----- --------- --- ------- -- ------- --
最后，我们在命令行输入以下命令即可生成 README.md 文件：
--- ---------------
至此，我们已经成功生成了一份漂亮的 README，展示出了 npm 包 sum.js 的基本信息和使用方法。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/600559e381e8991b448d7804