README_RU.md

Html Responsive Email Boilerplate

English README

Это стартовый boilerplate для простой верстки адаптивный электронных писем основанный на MJML и Gulp.

Возможности:

• Разработка писем используя фреймворк MJML в редакторе кода используя Gulp.
• Проверка шаблонов на ошибки.
• Использование переменных окружения. Например для подгрузки локальных картинок во время разработки и замены путей ассетов во время сборки на удаленные ресурсы.

Смотрите документацию.

Редактор и плагины

Рекомендуется использовать Visual Studio Code + MJML Plugin

Начало работы

• npm run install - для установки всех зависимостей.
• npm run dev - для разработки и запуска сервера с горячей перезагрузкой.
• npm run build - для сборки всех писем и минификации кода.

Документация

Документация по фреймворку MJML здесь

ENV Enjection

Вы можете вставлять переменные env в шаблоны. Используется плагин gulp-inject-envs.

Пример:

• Путь к ресурсам, уже задан как env ASSETS_PATH=/assets, смотрите package.json build и dev скрипты. можно установить разные переменные для разных окружений.

• Доступно шаблонах, как <ENV::ASSETS_PATH>. Например:

    <img src="<ENV::ASSETS_PATH>/logo.png" alt="Logo">

Рекомендуемая структура каталогов

• dist - построить выходной каталог и корень сервера.
• src/assets - каталог ресурсов.
• src/components - шаблоны MJML для включения. Документация.
• src/pages - страницы электронной почты.