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

登录后查看全文

项目优选

收起

kernel

deepin linux kernel

docs

OpenHarmony documentation | OpenHarmony开发者文档

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台，包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分，采用java语言实现，可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用

🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer（第 2 版）》、《程序员面试金典（第 6 版）》题解

Java

pytorch

Ascend Extension for PyTorch

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

喝着茶写代码！最易用的自托管一站式代码托管平台，包含Git托管，代码审查，团队协作，软件包和CI/CD。

RuoYi-Vue3

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

Vue

1.21 K

660