Juice 使用与技术文档

本文将详细介绍如何安装、使用 Juice 项目，以及如何使用其提供的 API。Juice 是一个可以将 CSS 属性内联到 HTML 元素的 style 属性中的工具，适用于 HTML 邮件和嵌入第三方网站的 HTML。

1. 安装指南

首先，您需要确保已经安装了 Node.js。然后，通过 npm 安装 Juice：

npm install juice

如果希望全局可用，可以使用 -g 参数：

npm install juice -g

2. 项目的使用说明

Juice 提供了多种方法来处理 HTML 字符串、文件和 cheerio 文档。以下是一些基本的使用方法：

内联 CSS

var juice = require('juice');
var result = juice("<style>div{color:red;}</style><div/>");
console.log(result);

输出结果：

<div style="color: red;"></div>

使用 CLI

可以通过命令行使用 Juice，安装全局模块后，运行以下命令：

juice input.html output.html

3. 项目 API 使用文档

以下是 Juice 提供的主要 API 方法：

juice(html [, options])

返回包含内联 CSS 的 HTML 字符串，不获取远程资源。

• html: HTML 字符串
• options: 可选，详细配置请参考下文

juice.juiceResources(html, options, callback)

获取远程资源后返回内联 CSS 的 HTML 字符串。

• html: HTML 字符串
• options: 配置选项
• callback(err, html): 回调函数，返回错误或内联 HTML

juice.juiceFile(filePath, options, callback)

读取文件并返回内联 CSS 的 HTML 字符串。

• filePath: HTML 文件路径
• options: 配置选项
• callback(err, html): 回调函数，返回错误或内联 HTML

juice.juiceDocument($ [, options])

在 cheerio 实例上执行内联操作，返回相同的 cheerio 实例。

• $: cheerio 实例
• options: 可选配置

juice.inlineContent(html, css [, options])

将提供的 CSS 内联到 HTML 中。

• html: HTML 字符串
• css: CSS 字符串
• options: 可选配置

juice.inlineDocument($, css [, options])

在 cheerio 实例上内联提供的 CSS。

• $: cheerio 实例
• css: CSS 字符串
• options: 可选配置

4. 项目安装方式

Juice 可以通过 npm 安装，全局或局部安装均可。全局安装后，可以通过命令行直接使用 Juice。

通过 npm 安装

npm install juice

通过 CLI 使用

安装全局模块后，使用以下命令：

juice input.html output.html

以上就是 Juice 项目的安装指南、使用说明和 API 使用文档。使用时，请根据具体需求调整配置选项，以实现最佳效果。