首页
/ premailer 项目技术文档

premailer 项目技术文档

2024-12-12 07:07:22作者：翟江哲Frasier
premailer
Turns CSS blocks into style attributes
项目地址：https://gitcode.com/gh_mirrors/pre/premailer

1. 安装指南

1.1 使用 pip 安装

要安装 premailer，首先确保你已经安装了 Python 环境。然后使用 pip 命令进行安装：

pip install premailer

1.2 验证安装

安装完成后，可以通过以下命令验证是否安装成功：

python -m premailer -h

如果成功，将显示 premailer 的帮助信息。

2. 项目的使用说明

2.1 基本使用

premailer 的主要功能是将 HTML 中的 CSS 样式块转换为内联样式属性。以下是一个基本的使用示例：

from premailer import transform

html_content = """
<html>
<style type="text/css">
h1 { border:1px solid black }
p { color:red;}
</style>
<h1 style="font-weight:bolder">Peter</h1>
<p>Hej</p>
</html>
"""

transformed_html = transform(html_content)
print(transformed_html)

输出结果将会是：

<html>
<h1 style="font-weight:bolder; border:1px solid black">Peter</h1>
<p style="color:red">Hej</p>
</html>

2.2 命令行使用

你也可以通过命令行使用 premailer：

python -m premailer --base-url=http://google.com/ -f newsletter.html

3. 项目API使用文档

3.1 transform 函数

transform 函数是 premailer 的核心功能，用于将 HTML 中的 CSS 样式转换为内联样式。函数的签名如下：

transform(html, base_url=None, disable_link_rewrites=False, preserve_internal_links=False, preserve_inline_attachments=True, preserve_handlebar_syntax=False, exclude_pseudoclasses=True, keep_style_tags=False, include_star_selectors=False, remove_classes=False, capitalize_float_margin=False, strip_important=True, external_styles=None, css_text=None, method="html", base_path=None, disable_basic_attributes=None, disable_validation=False, cache_css_parsing=True, cssutils_logging_handler=None, cssutils_logging_level=None, disable_leftover_css=False, align_floating_images=True, remove_unset_properties=True, allow_network=True, allow_insecure_ssl=False, allow_loading_external_files=False, session=None)

3.2 主要参数说明

  • base_url: 可选的 URL，用于将相对链接转换为绝对链接。
  • disable_link_rewrites: 是否禁用链接重写。
  • preserve_internal_links: 是否保留内部链接。
  • preserve_inline_attachments: 是否保留内联附件。
  • exclude_pseudoclasses: 是否忽略伪类。
  • keep_style_tags: 是否保留原始的 <style> 标签。
  • remove_classes: 是否移除 HTML 元素上的 class 属性。
  • strip_important: 是否移除 CSS 声明中的 !important。
  • external_styles: 可选的外部样式表 URL 列表。
  • css_text: 可选的 CSS 文本。
  • method: 输出的 HTML 类型，可以是 "html" 或 "xml"。
  • base_path: 外部样式表的基本路径。
  • disable_basic_attributes: 禁用的基本属性列表。
  • disable_validation: 是否禁用 CSS 验证。
  • cache_css_parsing: 是否缓存 CSS 解析结果。
  • allow_network: 是否允许网络访问以获取外部样式表。
  • allow_insecure_ssl: 是否允许不安全的 SSL 证书。
  • allow_loading_external_files: 是否允许加载任何非 HTTP 的外部文件 URL。

4. 项目安装方式

4.1 通过 pip 安装

premailer 可以通过 pip 进行安装，安装命令如下：

pip install premailer

4.2 从源码安装

如果你需要从源码安装，可以按照以下步骤操作：

  1. 克隆项目仓库：
git clone https://github.com/peterbe/premailer.git
  1. 进入项目目录：
cd premailer
  1. 安装依赖：
pip install -r requirements.txt
  1. 安装 premailer：
python setup.py install

通过以上步骤，你就可以成功安装并使用 premailer 项目。

premailer
Turns CSS blocks into style attributes
项目地址：https://gitcode.com/gh_mirrors/pre/premailer

相关内容推荐

1 📨 **探索高效邮件风格转换：go-premailer**2 推荐项目：Grunt Email Boilerplate3 推荐使用：Email Lab —— 高效开发与测试邮件模板的利器！4 `_` 项目技术文档5 使用Bootstrap构建高效HTML邮件的利器：Bootstrap for Email6 Hyde项目技术文档7 Soloist 项目技术文档8 OCHamcrest 项目技术文档9 get_iplayer 项目技术文档10 Ve 项目技术文档
热门项目推荐
相关项目推荐

热门内容推荐

1 开源项目 developer-roadmap 使用教程2 开发者路线图项目教程3 开源项目 `awesome-selfhosted` 使用教程4 Vue.js 教程与指南5 探索Vue 2的持久魅力：一个开源项目的深度解析6 Linux 内核项目使用教程7 开源项目指南：Linux 内核8 推荐项目：探索 Linux 内核的奥秘9 Linux内核项目技术文档10 TensorFlow 开源项目教程

最新内容推荐

《深入掌握OpenPTrack：安装与实战指南》 《RBM-MNIST深度学习算法安装与实战指南》 《Boundingmesh项目实战指南：安装、配置与深度探索》 探索三维世界：cpu_tsdf开源项目的安装与使用教程 探索Embxx：嵌入式C++库的安装与使用指南 深入解析Valijson：安装、使用与实践指南 《稳健点集配准算法GMMReg的安装与使用教程》 《luacppinterface：C++与Lua混合编程的桥梁》 深入掌握makerscanner：安装与使用指南 《SoftModem：开源的Arduino与手机通信解决方案》

项目优选

收起
MateChatMateChat
前端智能化场景解决方案UI库，轻松构建你的AI应用，我们将持续完善更新，欢迎你的使用与建议。 官网地址：https://matechat.gitcode.com
383
36
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
611
115
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码，欢迎大家投稿，让全世界看到您的妙趣设计，也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
205
58
Ffit-framework
FIT: 企业级AI开发框架，提供多语言函数引擎（FIT）、流式编排引擎（WaterFlow）及Java生态的LangChain替代方案（FEL）。原生/Spring双模运行，支持插件热插拔与智能聚散部署，无缝统一大模型与业务系统。
Java
113
13
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
45
29
cjoycjoy
a fast，lightweight and joy web framework
Cangjie
11
2
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码，欢迎大家投稿，在仓颉鸿蒙社区展现你的妙趣设计！
Cangjie
286
79
hertzhertz
Go 微服务 HTTP 框架，具有高易用性、高性能、高扩展性等特点。
Go
7
1
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件，通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求，让密码技术应用更简单，同时探索后量子等先进算法创新实践，构建密码前沿技术底座！
C
60
48
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件，采用集群高扩展架构，通过应用备份通用框架、并行备份等技术，为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力，帮助用户实现关键数据高效保护。
HTML
90
65