介绍
Projectz 是一个基于 Node.js 的命令行工具，用于生成漂亮的项目文档，并支持多种文档格式输出。使用 Projectz 可以帮助开发者提高项目的可读性和可维护性。
安装
在使用 Projectz 之前，需要先安装 Node.js 和 npm。安装完成后，在终端中执行以下命令即可安装 projectz：
--- ------- -- --------
使用步骤
步骤一：创建项目
在终端进入你要生成文档的项目根目录，执行以下命令创建项目文档：
-------- ------
此时，projectz 会询问一些基本信息（如项目名称、作者等），根据提示输入即可。
步骤二：编辑文档
在项目根目录中会出现一个 docs 文件夹，里面包含了一个 Markdown 文件 index.md，这个文件就是你要编写文档的地方。你可以使用任何一款 Markdown 编辑器进行编辑，比如 Typora。
步骤三：生成文档
当你完成了文档的编写后，执行以下命令即可生成文档：
-------- -----
此时，projectz 会根据 docs 文件夹中的 Markdown 文件自动生成文档。
步骤四：发布文档
如果你想将文档发布到 GitHub Pages 上，可以执行以下命令：
-------- -------
这个命令会自动将文档推送到 gh-pages 分支上，并在 GitHub Pages 上显示。
示例代码
- ---- --------- -- -- ------- ------- --- ------- -----------------
使用
使用方法如下：
----- ----------- - ----------------------------- --------------------------
API 文档
doSomething()
这是一个方法的说明。
-- -- ------------------- -------- ------------------------- ----------------------------------------------------------- ---------- ---------------------------------------------------------------------------------------