SingleFile Companion 使用教程

SingleFile Companion 使用教程

single-file-companion项目地址:https://gitcode.com/gh_mirrors/si/single-file-companion

1、项目介绍

SingleFile Companion 是一个运行在浏览器之外的程序，它增强了 SingleFile 插件的功能。SingleFile 是一个浏览器扩展，用于将完整的网页保存为一个 HTML 文件。SingleFile Companion 可以使得保存过程更加透明，特别是在自动保存功能激活时。它还支持在匿名会话中自动保存页面，并将页面保存到与下载目录不同的其他目录中。

2、项目快速启动

安装步骤

1. 安装 Node.js：确保你的系统上安装了 Node.js。
2. 下载项目：从 GitHub 下载 SingleFile Companion 项目压缩包并解压到你的硬盘上。
3. 安装依赖：在解压后的根目录中运行 npm install。
4. 配置安装：
   • 进入对应你操作系统和浏览器的子目录，例如，如果你使用的是 Chrome 在 Linux 上，则运行：

     cd companion/linux/chrome
     

   • 使安装脚本可执行：

     chmod +x install.sh
     

   • 运行安装脚本：

     ./install.sh
     

5. 启用 SingleFile Companion：在 SingleFile 扩展中启用 Destination > save with SingleFile Companion 选项。

配置文件

在 options.json 文件中，你可以配置以下选项：

• savePath：文件保存路径（默认：/WebArchives/）
• errorFilePath：错误日志文件路径（默认：未定义）

3、应用案例和最佳实践

应用案例

• 自动保存网页：使用 SingleFile Companion 可以在后台自动保存网页，无需手动操作。
• 匿名会话保存：在匿名或隐私浏览模式下，SingleFile Companion 可以自动保存网页。

最佳实践

• 定期备份：设置定期任务，使用 SingleFile Companion 自动保存重要网页，以防数据丢失。
• 错误监控：定期检查 errorFilePath 指定的错误日志文件，确保保存过程无误。

4、典型生态项目

• SingleFile：SingleFile Companion 的主要依赖项目，用于保存完整的网页。
• Puppeteer：作为后端服务，用于自动化和控制浏览器行为。

通过以上步骤和配置，你可以有效地使用 SingleFile Companion 来增强你的网页保存体验。

single-file-companion项目地址:https://gitcode.com/gh_mirrors/si/single-file-companion