# gemkt

> generator email marketing

Latest version **0.0.15** (published 2021-08-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install gemkt
pnpm add gemkt
yarn add gemkt
bun add gemkt
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.15 |
| Published | 2021-08-07 |
| First published | 2021-08-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 10.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Francisco Ossian |
| Maintainers | francisco-ossian |

## Links

- npm: https://www.npmjs.com/package/gemkt
- Repository: https://github.com/FranciscoOssian/gemkt
- Homepage: https://github.com/FranciscoOssian/gemkt#readme
- Issues: https://github.com/FranciscoOssian/gemkt/issues
- npm.io page: https://npm.io/package/gemkt

## Dependencies (2)

- [jimp](https://npm.io/package/jimp.md) ^0.16.1
- [prompt-sync](https://npm.io/package/prompt-sync.md) ^4.2.0

## Recent versions

- 0.0.15 (latest) — 2021-08-07
- 0.0.14 — 2021-08-07
- 0.0.13 — 2021-08-07
- 0.0.12 — 2021-08-07
- 0.0.11 — 2021-08-07
- 0.0.10 — 2021-08-07
- 0.0.9 — 2021-08-06
- 0.0.8 — 2021-08-06
- 0.0.7 — 2021-08-06
- 0.0.6 — 2021-08-06
- 0.0.4 — 2021-08-06
- 0.0.3 — 2021-08-06
- 0.0.2 — 2021-08-06
- 0.0.1 — 2021-08-06
- 0.0.0 — 2021-08-06

## README

# Gemkt 
a email marketing generator.

type ```node . help``` to see the lite doc of the gemkt

# Project struct to run the library

```
📦teste
 ┣ 📂htmls
 ┃ ┣ 📂build
 ┃ ┃ ┗ 📜index.html
 ┃ ┣ 📜out.html
 ┃ ┗ 📜template.html
 ┣ 📂images
 ┃ ┣ 📜index_02.png
 ┃ ┣ 📜index_03.png
 ┃ ┗ 📜index_04.png
 ┣ 📜data.json
 ┣ 📜gemkt.config.js
 ┣ 📜index.js
 ┗ 📜package.json
 ```

# GEMKT function

## Parameters

<table>
  <tr>
    <th>Name</th>
    <th>Type</th> 
    <th>Use</th>
  </tr>
  <tr>
    <td>help</td>
    <td>boolean</td>
    <td>To execute the help function</td>
  </tr>
  <tr>
    <td>cleanCache</td>
    <td>boolean</td>
    <td>To clean the cache of html data</td>
  </tr>
  <tr>
    <td>templateCmd</td>
    <td>array</td>
    <td>Array to define the number of images in one line</td>
  </tr>
</table>

# GEMKT config file js (gemkt.config.js)

Gemkt configuration works with a ```gemkt.config.js``` file declareted in your project root.

## Example of gemkt.config.js file

```
const { resolve } = require('path');

config = {
  paths: {
    outFile: resolve('htmls/out.html'),
    templateFile: resolve('htmls/template.html'),
    imagesFolder: resolve('images/'),
    dataFile: resolve('data.json'),
  }
}

module.exports = config

```

# The Data file

In your projet you will declare a data.json file, with contains the images, links and alts of the email marketing.

Its a Arry with each element contains a Object with image, link and alt for construct the html file.

# The especial CleanCache prop

In Gemkt main function parameter object, exists a prop calls cleanCache. This props when ```true``` automatically clean the link, alt, image filds of data.json and populates data.json with images based on images folder

---
_Source: https://npm.io/package/gemkt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
