MJML-Go 使用教程

1. 项目介绍

MJML-Go 是一个可以将 MJML（Mailchimp Template Language）编译为 HTML 的 Go 语言库。它通过内置的 WebAssembly 模块，避免了依赖 Node.js 服务器的需求，使得 Go 应用程序可以直接部署为一个单一的二进制文件。这个库提供了一系列的选项来自定义 MJML 的编译过程，包括对 HTML 进行压缩和美化。

2. 项目快速启动

首先，确保您的环境中已经安装了 Go。

go install github.com/Boostport/mjml-go@latest

然后，您可以使用以下代码示例来快速启动一个 MJML 到 HTML 的转换：

package main

import (
	"context"
	"fmt"
	"github.com/Boostport/mjml-go"
)

func main() {
	input := `<mjml><mj-body><mj-section><mj-column><mj-divider border-color="#F45E43"></mj-divider><mj-text font-size="20px" color="#F45E43" font-family="helvetica">Hello World</mj-text></mj-column></mj-section></mj-body></mjml>`

	output, err := mjml.ToHTML(context.Background(), input, mjml.WithMinify(true))
	if err != nil {
		fmt.Println("Error:", err)
		return
	}

	fmt.Println(output)
}

这段代码将 MJML 字符串转换为 HTML，并输出结果。

3. 应用案例和最佳实践

应用案例

• 电子邮件模板渲染：使用 MJML-Go，开发者可以在 Go 应用程序中直接渲染电子邮件模板，而不需要依赖外部 Node.js 服务。
• Web 应用程序集成：集成到 Web 应用程序中，为用户提供实时的 MJML 到 HTML 的转换。

最佳实践

• 使用配置文件：为了更好地管理 MJML 编译选项，可以将选项存储在配置文件中，以便重用和修改。
• 错误处理：确保对 mjml.ToHTML 函数的调用进行错误处理，以优雅地处理转换过程中的任何问题。

4. 典型生态项目

目前，MJML-Go 作为一个相对较新的项目，其生态系统还在不断发展中。以下是一些可能与之配合使用的项目：

• WebAssembly 运行时：如 Wazero，用于在 Go 应用程序中运行 WebAssembly 模块。
• HTML 处理库：例如 html/template，用于进一步处理 MJML-Go 输出的 HTML 内容。

以上就是 MJML-Go 的基本使用教程，希望对您有所帮助。