bookjs-eazy 使用指南

bookjs-eazy 使用指南

1. 项目目录结构及介绍

bookjs-eazy 是一个用于简化HTML转PDF过程的开源项目，特别是优化了WEB打印和HTML自动分页的功能。以下是该项目的主要目录结构及其简介：

• bin: 包含与项目运行相关的脚本文件。
• converter: 通常存放转换逻辑相关的代码或工具。
• dist: 经过构建后可直接部署的文件夹，包含示例页面和其他静态资源。
• editorconfig: 编辑器配置文件，用于保持代码风格一致。
• gitattributes: Git属性文件，影响Git如何处理特定文件。
• gitignore: 指定Git应忽略的文件或文件夹列表。
• LICENSE: 许可证文件，表明项目遵循MIT协议。
• README-en.md: 英文版的项目说明文档。
• README.md: 中文版的主读我文件，详细介绍了项目用途和快速上手指南。
• package.json: Node.js项目的配置文件，包括依赖、脚本指令等。
• qq-group-1.png: 可能是项目维护者提供的QQ群二维码图片。
• simple-4-qrcode.png: 示例二维码图片，可能与项目演示相关。
• wslpath.bat: Windows Subsystem for Linux路径辅助脚本。

2. 项目的启动文件介绍

项目的核心启动可以通过以下两个脚本来实现：

• docker-start.sh: 如果你打算在Docker环境中运行这个项目，这个shell脚本可以帮助你快速启动服务。适用于Linux或macOS环境。
• docker-start.bat: 类似地，这是为Windows环境准备的批处理脚本，用于在Docker环境下启动项目。

启动步骤概括为：

1. 克隆或下载项目到本地。
2. 使用相应的启动脚本(docker-start.sh或docker-start.bat)。
3. 访问 http://127.0.0.1:3000/eazy-1.html 来查看示例页面并测试PDF生成功能。

3. 项目的配置文件介绍

配置主要通过JavaScript对象bookConfig来完成，该配置位于HTML文件内的 <script> 标签中。这里的关键配置项包括但不限于：

• start: 控制渲染开始的标志，动态页面需设置为false，在内容加载完毕后再更改为true。
• pageSize: 纸张大小，例如 'ISO_A4'，支持多种国际标准尺寸。
• orientation: 页面方向，可以是 'portrait' 或 'landscape'。
• padding: 页面边距，默认值提供了四个维度的设定。
• printDelay: 生成PDF前的延迟时间，用于确保异步内容加载完成。
• simplePageNum, simpleCatalog: 分别用于控制简易页码和目录插件的启停及自定义。

此外，bookConfig 还允许更精细的控制，比如高度修复、打印背景强制、文本处理选项等。配置的细节直接决定了PDF的布局、外观和交互性。

在实际应用中，开发者需要在HTML文档内根据具体需求定制bookConfig，并且确保PDF内容通过正确的DOM节点结构（如 #content-box）来组织，以便于bookjs-eazy能够正确识别并处理这些内容进行PDF转换。