Open-source

emailmd — Markdown-письма с HTML и текстовой MIME-версией

Обзор по документации проекта · Проверено

emailmd — изображение проекта

emailmd преобразует Markdown в HTML для почтовых клиентов и отдельный plain-text вариант письма. Библиотека и CLI помогают готовить рассылки с оформлением и текстовыми диаграммами.

Возможности и состав проекта

Проект позволяет генерировать не только HTML-версию письма, но и его текстовый аналог для MIME-части text/plain. emailmd поддерживает специальные директивы для создания графиков и диаграмм (например, столбчатых диаграмм, индикаторов прогресса) из обычных списков Markdown. Эти элементы отображаются с помощью текстовых символов, а не изображений, что обеспечивает их отображение даже при блокировке внешних изображений почтовым клиентом. Также доступен интерфейс командной строки.

Начало работы и требования

Для работы emailmd требуется Node.js версии 20 или выше, поскольку он использует MJML 5. Проект находится в активной разработке, и его API может изменяться между минорными версиями до достижения версии 1.0. emailmd распространяется по лицензии MIT. Существует также пакет @emailmd/react для интеграции с React-приложениями, предоставляющий хук useEmailmd, компонент EmailPreview и EmailmdBuilder.

Ограничения и выбор сценария

Email-safe означает подготовку верстки под почтовые клиенты, а не гарантию безопасности любого входного HTML. В версии 0.3 render стал асинхронным, а MJML 5 требует Node.js 20+. Получившееся письмо нужно проверить в целевых клиентах, включая отображение без внешних изображений.

Лицензия и условия использования

GitHub определяет лицензию репозитория как MIT. Перед использованием и распространением проверьте полный текст LICENSE и отдельные условия зависимостей, данных или моделей: лицензия репозитория не заменяет их лицензии.

Источники и документация