随着前端项目复杂度的提高，文档编写显得越来越重要。在 npm 包的包体积中，文档占比也越来越高。这时候，我们就需要一个好用的文档生成工具。zendoc 就是一个很不错的选择。本文将详细介绍如何使用它。
什么是 zendoc？
zendoc 是一个基于 Markdown，可以快速生成文档的命令行工具。它使用了 EJS 和 CSS 预编译技术，可以灵活定制生成的文档风格。同时，它也支持生成 PDF，方便交付给业务需求方。
安装
全局安装
--- ------- -- ------
项目安装
--- ------- ------ ----------
使用
初始化配置文件
在项目根目录下执行：
------ ----
初始化后，会生成一个 zendoc.json 的配置文件。可以在此文件中进行文档生成相关的配置。
编写文档
在项目中新建 docs 目录，并在其中编写文档。可以按照 Markdown 的语法进行书写。在文档中，可以使用 --- 分割，来将一个文档拆分为多个部分。
配置文件
示例配置文件如下：
-
-------- -------
---------- ------
-------- -------
-------------- -------
------------- -
--------- -----
-------------- ----------
--
------- -
-
-------- ---------
------- ----------------
-
-
-所有配置项的说明如下:
title：文档标题version：文档版本号theme：生成文档的主题，支持多款主题，使用的是ejsx模板渲染引擎description：文档描述pdfOptions：生成 PDF 的配置，支持自定义 format 和 orientationdocs：文档部分，支持多份文档，路径是相对于项目根目录的
生成文档
执行 zendoc 命令即可生成文档：
------ -------- ----------- -------- ------
--config：指定上面所说的配置文件--output：指定生成的文档输出目录，默认是./docs-output
生成 PDF
执行下面的命令即可生成 PDF 阅读格式的文档。
------ -------- ----------- -------- ------ -----
总结
zendoc 是一个使用简单，定制性高的文档生成工具。使用它，可以节省大量文档编写的时间，并且生成出来的文档风格也很好看。同时，它非常轻量，只有1.5MB的大小。相信你会喜欢它的。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60055ffe81e8991b448ddceb