简介
在前端开发过程中，我们经常需要编写文档来记录项目的信息和维护说明。那么如何才能够快速地生成文档并且方便地查看呢？这时，npm 包 topolr-doc 就会帮助到你。
topolr-doc 是一个可以生成文档并支持 markdown 和代码高亮的工具。它可以读取项目中的所有 js 文件，并通过注释生成文档。同时，它也可以在浏览器中直接运行，方便查看文档。
下面，我们将详细介绍 topolr-doc 的使用方法，并提供示例代码来帮助大家更好地理解。
安装
topolr-doc 可以通过 npm 安装，只需要在命令行中输入以下命令即可：
npm install -g topolr-doc
使用方法
1. 生成文档
使用 topolr-doc 生成文档非常简单，只需要在命令行中进入项目的根目录，并输入以下命令：
topolr-doc -i ./src -o ./docs
其中，-i 表示读取的文件路径，-o 表示生成文档的路径。
2. 配置文件
如果想要自定义生成文档的样式和配置，可以在项目根目录中添加 topolr.config.js 文件。以下是示例配置：
-- -------------------- ---- -------
-------------- - -
--------- -------------
---------------- -- --------- --- -------- -------------- ---- ------ --------- --- --------
--------- ------
----------- ------------------
--------- -----
------- ----------
----- --
----- -------
----- -----------
--------- ------
---
---------- ---
-------- ---
------------- ---
-------------- --
--在配置文件中，我们可以设置文档的名称、描述、文档的存储路径、代码的类型、导航配置等等。此外，我们还可以在配置文件中引入外部插件和自定义样式、脚本，以满足个性化需求。
3. 运行
运行 topolr-doc 有两种方式，一种是直接通过命令行运行：
topolr-doc --server
另一种是通过配置文件进行运行：
const topolrDoc=require('topolr-doc');
const config=require('./topolr.config.js');
topolrDoc(config);通过以上两种方式，我们都可以在浏览器中打开 http://localhost:9090 访问生成好的文档。
示例代码
以下是 topolr.config.js 文件的完整示例代码：
-- -------------------- ---- -------
-------------- - -
--------- -------------
---------------- -- --------- --- -------- -------------- ---- ------ --------- --- --------
--------- ------
----------- ------------------
--------- -----
------- ----------
----- --
----- -------
----- -----------
--------- ------
---
---------- ---
-------- ---
------------- ---
-------------- --
--
运行以下命令即可在项目根目录生成 docs 文件夹：
topolr-doc -i ./src -o ./docs
然后，在 docs 目录下运行以下命令即可启动服务器：
topolr-doc --server
打开浏览器访问 http://localhost:9090 即可查看生成的文档。
总结
通过以上的介绍，我们可以轻松地使用 topolr-doc 快速生成文档，并且可以通过配置文件来满足个性化需求。希望大家可以通过使用这个工具来提高自己的开发效率，同时也为开源社区做出贡献。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600555ca81e8991b448d2e10