npm 是 Node.js 的包管理器，其中有很多优秀的开源前端包供我们使用。其中，preacher 是一个可以让我们更好地阐述项目目的、逻辑以及解决方案的 npm 包。本文将介绍 preacher 的使用教程，使您能够更加高效地使用它来编写更好的代码。
安装 preacher
我们可以通过 npm 安装 preacher，首先在终端输入以下命令：
npm install -g preacher
如果您拥有较高的权限，则可以使用 -g 参数来全局安装 preacher，否则可能需要使用 sudo 命令进行安装。
使用 preacher
安装完成后，我们可以在终端输入 preacher 命令来创建项目。该命令会提示您输入项目名称、作者等信息，如下所示：
$ preacher ? What's your project name? MyProject ? What's your project version? 0.0.1 ? What's your author name? John Doe ? Add project description? Yes ? Describe your project: This is a demo project. ...
完成上述信息录入后，preacher 就会自动为您创建一个 README.md 文件，其中包含了您所录入的信息。如下所示：
-- -------------------- ---- ------- - --------- --------------------------------------------------------------------------------------------- ---- -- - ---- -------- -- ------------ ----- --- ------- ---------
Usage
const myproject = require('myproject');
console.log(myproject());
//=> 'myproject'API
myproject()
Returns: string
Returns the string myproject.
License
MIT © John Doe
-- -------------------- ---- -------
---------------------
-- -- --------
------------ -------------- ------ ------------ -------------- --------
-------
-
------- ------------
---------- --------
-------------- ----- -- - ---- ----------
------- -----------
----------- -
-------- -
----------
----------------------
--
----------- ----------
----------- -
-
-------- ------ -- ----------
--------- -----
--
-
-------- ---------------
--------- --------------
--
-
-------- --------
--------- -------
--
-
-------- ----------
--------- ---------
-
-
--
--------- ----- -----
---------- -----
-在上述示例中，我们配置：
files下的**/*.md表示 preacher 会搜索项目根目录下所有.md文件，并将它们添加到README.md文件中。template表示 readme 文件的模板，可以指定自定义的模板路径或者使用默认的default模板。sections则是我们需要插入到README.md文件中的章节信息，您可以自定义标题、锚点等内容。
配置完成后，我们可以使用以下命令重新生成 README.md 文件：
preacher
结语
本文介绍了 npm 包 preacher 的使用教程，如果您在编写项目文档时感到困难，preacher 将会是您的良师益友。希望本文对您有所帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005757f81e8991b448ea5f9