什么是 hyperdoc？
Hyperdoc 是一个文档生成器，具有非常强大的定制化能力，可以轻松生成漂亮的、易于维护的、具有交互性的文档。
安装
要安装 hyperdoc ，你需要首先安装 Node.js 和 npm ，然后通过 npm 安装 hyperdoc 包。
- -- --- ------- -- -------- - -- --- ------- -- ---------------
使用
初始化
在项目的根目录下创建一个目录来存放你的 markdown 文件，然后运行以下命令初始化 hyperdoc：
- --- -------- ----
该命令将创建一个 .hyperdoc 目录，并在该目录下生成配置文件 config.json 和 doc.css 文件。
编写文档
在该目录下创建一个 markdown 文件，并将其命名为 README.md ，然后在该文件中编写你的文档。
配置
在 config.json 文件中进行配置。你可以在这个文件中指定输出的文档类型（html, pdf, epub等），样式（字体，颜色，边距等），以及文档的构建方式（排序，分类，索引）等等。
以下是一个简单的配置示例：
-
--------- ----------
-------- ----------
-------- --- ------- -----
--------- -
------- -------
------ --------
--
----------- -
-----------
-
-构建
在 hyperdoc 根目录下执行以下命令来构建你的文档：
-------- -----
完成后， hyperdoc 将会在配置文件中指定的路径 output.dir 下生成你的文档。
示例
以下是一个生成文档的示例，我们将在 mydoc 目录下创建一个名为 README.md 的文件，用来编写文档
- -- -------- ----------- -- --- ------------- ------------------ ---------
段落
这是一个段落，这是另一个段落。
列表
- Apple
- Banana
- Cherry
---------------------- -------- ------------------------- ----------------------------------------------------------- ---------- ---------------------------------------------------------------------------------------