Nodejs官方API文档如何编译并制作成CHM文件，方便翻看

Nodejs官方API文档如何编译并制作成CHM文件，方便翻看

从Node源码中编译的文档是包含Node官网全页面的，所以制作了两份CHM文件：

nodeapidoc.full.chm:Node官网全页面
nodeapidoc.min.chm：只包含NodeJS Api Doc
后者只有几百KB，下这个好了~（下载应该会吧 亲）
有个CHM文件还是挺方便的，嘿嘿 拿出来共享下， 记得给好评哦 亲~~

也可以来去我的github去拉HTML源码~

此外这哥们儿也hack了一个比官方文档更漂亮且实用的文档
可搜索哦 亲~~


17 回复

Node.js 官方 API 文档如何编译并制作成 CHM 文件，方便翻看

从 Node.js 源码中编译的文档是包含 Node 官网全页面的，因此可以制作两份 CHM 文件：

后者只有几百 KB，下载这个就好啦~（下载应该会吧 亲）

有个 CHM 文件还是挺方便的，拿出来共享下，记得给好评哦 亲~~

你也可以直接从我的 GitHub 下载 HTML 源码，自行编译生成 CHM 文件。

此外，Miller Medeiros 也做了一个比官方文档更漂亮且实用的版本，支持搜索功能哦 亲~~

如何编译 Node.js 官方 API 文档并生成 CHM 文件？

以下是简要步骤和示例代码：

  1. 克隆 GitHub 仓库

    git clone https://github.com/sunshine1988/nodeapidoc.git
cd nodeapidoc

  2. 安装所需工具 需要安装 HTML Help Workshop 工具来生成 CHM 文件。可以从微软官方网站下载。

  3. 编译 HTML 文件 使用 HTML Help Workshop 工具，打开 nodeapidoc.hhp 文件（该文件包含编译配置），然后点击 “Compile” 按钮生成 CHM 文件。

  4. 获取 CHM 文件 编译完成后，可以在项目目录中找到生成的 CHM 文件。

示例代码

假设你已经安装了 HTML Help Workshop，并且将它添加到了系统路径中，你可以使用以下命令编译：

# 打开 .hhp 文件
htmlhelp.exe nodeapidoc.hhp

这将启动 HTML Help Workshop 并自动编译你的 HTML 文件为 CHM 文件。

通过这些步骤，你可以轻松地将 Node.js 官方 API 文档编译成 CHM 文件，方便离线查阅。


json -> vim =====> 自动补全IDE

外加documentation提示，完美…………

嘿嘿 说的这么热闹 拿出来分享下~

这个可以顶！

顶顶更健康吗？哈哈

求分享

顶，谢谢分享

不能下啊

您好，DeNA在招聘资深Node.js的职位，您有兴趣了解一下吗？

竟然在此相遇,彬哥

devdocs.io

请问作者，是怎么编译 nodejs 官方 docs 的？

chm文档好像并不能打开

文档和代码一样是迭代的，虽然不一定频繁，但文档固化并不是好实践，国内的很多人深受其害（从我看PHP社区的体验），CHM阅读也并不方便，搜索功能也有限。上路的方法是直接用Google，或者直接参考官方文档，收藏一个浏览器书签就可以了，并不麻烦，阅读和搜索要友好得多 http://t.cn/a0XheP 用CHM文档，是一种坏习惯。

怎么做到的？

要将Node.js官方API文档编译成CHM文件，可以使用一些工具来完成。虽然Node.js官方没有直接提供这样的工具，但你可以通过一些第三方工具来实现这个目标。这里以使用HTM2CHM工具为例，它可以帮助你将HTML文档转换为CHM文件。

示例步骤：

  1. 获取Node.js文档：

    • 从Node.js GitHub仓库克隆或下载官方文档。
    • 例如，你可以从GitHub上下载nodejs/node-api-docs项目。

  2. 安装HTM2CHM工具：

    • HTM2CHM是一个Windows平台的工具，可以将HTML文件打包成CHM格式。
    • 下载并安装HTM2CHM工具：HTM2CHM下载链接

  3. 配置HTM2CHM：

    • 打开HTM2CHM工具，并导入Node.js文档中的HTML文件。
    • 配置项目参数，包括标题、文件夹路径等。
    • 添加必要的索引和书签。

  4. 生成CHM文件：

    • 完成配置后，点击生成按钮，HTM2CHM会将HTML文件打包成CHM文件。

示例代码：

由于HTM2CHM是一个图形界面工具，不需要编写复杂的代码。但是，如果你希望自动化这个过程，可以使用命令行工具如makechm，这是一个跨平台的工具。

# 安装makechm
npm install -g makechm

# 创建一个配置文件（config.makechm）
echo "title = Node.js API Documentation" > config.makechm
echo "output = nodeapi.chm" >> config.makechm
echo "files = ./node-api-docs/*" >> config.makechm

# 使用makechm生成CHM文件
makechm config.makechm

注意事项：

  • 确保你有足够的权限访问和修改文件。
  • 如果你在Linux或Mac上操作，确保安装了相应的工具。

结论：

通过上述步骤，你可以将Node.js官方API文档转换为CHM文件，方便查阅。尽管上述过程主要基于HTM2CHM工具，你可以根据需要选择其他适合的工具来完成这一任务。

回到顶部