chm开源文档制作

Posted 2020-07-23 临渊启明

作为开发人员，API 文档是非常关键的^_^，但是很多时候官方提供的文档是 html 的 docs，不方便于携带查询，这种情况下，当然是要做成 CHM 啦！！

一、使用 jd2chm 制作 chm 文档

官网地址：https://www.burgaud.com/jd2chm.html

1）先安装 htmlhelp.exe
2）将 jd2chm.exe 复制 C:\\WINDOWS\\system32 目录（这样就可以直接使用 jd2chm 命令操作
3）打开 cmd 命令行窗口，进入到需要转换的 docs 主目录下（该目录下必须包含 index.html 文件）
4）输入 jd2chm ，按提示输入项目名称和 chm 文件名称，即可。成功后，即在 index.html 同级目录下生成 chm 文件。

二、FAQ

使用 jd2chm 出现如上报错，原因是：主目录识别错误，我测试用的文档，在 docs 下是有一个index.html，在 docs\\api 下面也有一个 index.html，进入 api 目录后执行 java2chm 即可（因为 api 才是主目录）。