Roadie 项目技术文档

2024-12-20 20:56:51作者：温艾琴Wonderful

1. 安装指南

安装环境要求

Ruby 环境

安装步骤

在项目的 Gemfile 中添加以下内容：
```
gem 'roadie', '~> 5.2'
```
运行以下命令安装 gem：
```
bundle install
```

2. 项目的使用说明

基本使用

Roadie 是一个用于处理 HTML 邮件的 Ruby gem，主要功能包括：

将样式表内联到 HTML 中。
将相对 URL 转换为绝对 URL。

示例代码

转换完整文档

document = Roadie::Document.new "<html><body></body></html>"
document.add_css "body { color: green; }"
document.transform
# => "<html><body style=\"color:green;\"></body></html>"

转换部分文档

document = Roadie::Document.new "<div>Hello world!</div>"
document.add_css "div { color: green; }"
document.transform_partial
# => "<div style=\"color:green;\">Hello world!</div>"

3. 项目API使用文档

主要API

Roadie::Document.new(html)：创建一个新的 Roadie 文档实例。
document.add_css(css)：向文档中添加 CSS 样式。
document.transform：转换完整文档。
document.transform_partial：转换部分文档。

配置选项

url_options：配置绝对 URL 的生成方式。
keep_uninlinable_css：设置为 false 以跳过无法内联的 CSS。
merge_media_queries：设置为 false 以不合并媒体查询。
asset_providers：配置 CSS 文件的资源提供者。
external_asset_providers：配置外部 CSS 文件的资源提供者。
before_transformation：转换开始前的回调。
after_transformation：转换完成后的回调。
serialization_options：传递给 Nokogiri 的序列化选项。

示例配置

document.url_options = {host: "myapp.com", protocol: "https"}
document.asset_providers = [
  Roadie::FilesystemProvider.new('/path/to/stylesheets')
]

4. 项目安装方式

通过 Gemfile 安装

在项目的 Gemfile 中添加以下内容：

gem 'roadie', '~> 5.2'

然后运行：

bundle install

手动安装

可以通过以下命令手动安装 Roadie：

gem install roadie -v 5.2

总结

Roadie 是一个强大的工具，能够帮助开发者轻松处理 HTML 邮件中的样式和 URL 问题。通过本文档，您可以快速了解如何安装、配置和使用 Roadie，从而提高开发效率。

roadie

Making HTML emails comfortable for the Ruby rockstars

项目地址：https://gitcode.com/gh_mirrors/ro/roadie

登录后查看全文

项目优选

收起

Ascend Extension for PyTorch

本项目是CANN提供的数学类基础计算算子库，实现网络在NPU上加速计算。

openEuler内核是openEuler操作系统的核心，既是系统性能与稳定性的基石，也是连接处理器、设备与服务的桥梁。

433

392

MindSpeed-MM

华为昇腾面向大规模分布式训练的多模态大模型套件，支撑多模态生成、多模态理解。

Claude Code 的开源替代方案。连接任意大模型，编辑代码，运行命令，自动验证 — 全自动执行。用 Rust 构建，极致性能。｜ An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get Started

🎉 (RuoYi)官方仓库基于SpringBoot，Spring Security，JWT，Vue3 & Vite、Element Plus 的前后端分离权限管理系统

Vue

1.67 K

986

Roadie 项目技术文档

1. 安装指南

安装环境要求

安装步骤

2. 项目的使用说明

基本使用

示例代码

转换完整文档

转换部分文档

3. 项目API使用文档

主要API

配置选项

示例配置

4. 项目安装方式

通过 Gemfile 安装

手动安装

总结

热门内容推荐

最新内容推荐

项目优选

Roadie 项目技术文档

1. 安装指南

安装环境要求

安装步骤

2. 项目的使用说明

基本使用

示例代码

转换完整文档

转换部分文档

3. 项目API使用文档

主要API

配置选项

示例配置

4. 项目安装方式

通过 Gemfile 安装

手动安装

总结

相关内容推荐

热门内容推荐

最新内容推荐

项目优选