Skip to content

Latest commit

 

History

History
99 lines (84 loc) · 4.64 KB

README.md

File metadata and controls

99 lines (84 loc) · 4.64 KB
Raw

Create Archive HTML Email

Screenshot-2024-04-25-123930

Cahe (Create Archive HTML Email) — это CLI инструмент для создания архивов HTML-рассылок. Он уменьшает размер HTML, переносит CSS-свойства в атрибут style HTML-элементов, обрабатывает изображения (сжатие, изменение размера, конвертация svg) и упаковывает всё в ZIP-файл. Так же есть возможность создать веб-версию письма. Подходит для работы с Unisender и другими похожими сервисами.

🛠 Технологии:

💾 Установка:

Перед использованием убедитесь, что у вас установлен Node.js.

  1. Склонируйте репозиторий:
git clone https://github.com/rastereo/cahe.git
  1. Перейдите в директорию проекта:
cd cahe
  1. Установите зависимости:
npm install
  1. Сделайте файл cahe.js исполняемым:
npm run init

🤖Использование:

Запустите скрипт в терминале, указав абсолютный путь к HTML-файлу:

cahe "C:\path\to\your\file.html"

Так же можно указать относительный путь:

cahe file.html

Архив .zip создастся в каталоге, где находится HTML-файл и путь к нему автоматически сохранится в буфер обмена.

Если нужно извлечь содержимое архива, укажите флаг -e после пути к HTML-файлу:

cahe file.html -e

Или просто укажите путь к ZIP-файлу:

cahe file.zip

Архива будет извлечен в каталог /build, где лежит HTML-файл.

Как автоматически изменять размер изображений

Добавьте в HTML элементу img атрибут data-width с нужной шириной в px.

<img src="images/banner.png" width="100%" data-width="600" />

Скрипт изменит разрешение фотографии, подгонит ширину в 600px и сохранит в архив, исходный файл не изменится.

Если нужно создать веб-версию письма:

  1. Зарегистрируйтесь на сайте Netlify и получите токен.
  2. В корне директории /cahe создайте файл .env.
  3. В файле .env укажите ваш ключ:
NETLIFY_KEY=ваш_ключ_api
  1. При необходимости можно также указать прокси:
PROXY=адрес_прокси
  1. В терминале укажите флаг -w после пути к HTML-файлу:
cahe file.html -w

Так же можно сразу указать путь до архива в формате .zip(другие форматы не подходят)

cahe file.zip -w

Файл config.json создастся в каталоге, где находится HTML файл. Внутри будет ссылка на веб-версию письма, а также в консоли при завершении. Последующие правки будут изменятся по той же ссылке. Если нужно создать новую ссылку, удалите config.json файл или удалите в нем строчку siteID

🧾MIT Licensed