Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hteumeuleu/caniemail
Can I email… Support tables for HTML and CSS in emails.
https://github.com/hteumeuleu/caniemail
css email-geeks email-marketing emails html html-email html-emails jekyll
Last synced: about 1 month ago
JSON representation
Can I email… Support tables for HTML and CSS in emails.
- Host: GitHub
- URL: https://github.com/hteumeuleu/caniemail
- Owner: hteumeuleu
- License: mit
- Created: 2019-03-14T21:19:03.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-07-29T15:27:18.000Z (about 1 month ago)
- Last Synced: 2024-07-29T20:47:40.329Z (about 1 month ago)
- Topics: css, email-geeks, email-marketing, emails, html, html-email, html-emails, jekyll
- Language: HTML
- Homepage: https://www.caniemail.com
- Size: 2.49 MB
- Stars: 785
- Watchers: 15
- Forks: 68
- Open Issues: 95
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-opensource-email - Can I email - Can I email… Support tables for HTML and CSS in emails. (Code / Other)
README
# Can I email…
[caniemail.com](https://www.caniemail.com) provides email clients support tables for HTML and CSS features.
_Can I email_ runs on [Jekyll](https://jekyllrb.com/docs/) as [GitHub Pages](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages) site with a home made theme. The site uses [Sass](https://sass-lang.com/) for CSS compilation.
## Installation
1. **Clone the repository**.
```sh
git clone https://github.com/hteumeuleu/caniemail.git
```
See [Cloning a repository](https://help.github.com/en/articles/cloning-a-repository) on GitHub documentation. If you're not familiar with Git or GitHub, I strongly encourage you to try [GitHub's desktop app](https://desktop.github.com/) on macOS, Windows or Linux.
2. **Install Jekyll** and other dependencies.
```sh
bundle install
```
See [Jekyll Installation Guide](https://jekyllrb.com/docs/installation/).
3. **Run Jekyll**.
```sh
bundle exec jekyll serve
```
You can turn on [incremental regeneration](https://jekyllrb.com/docs/configuration/incremental-regeneration/) with the `--incremental` flag.
```sh
bundle exec jekyll serve --incremental
```
The _embed_ version of the site ([embed.caniemail.com](https://embed.caniemail.com)) is built by specifiying the config file to use.
```sh
bundle exec jekyll serve --config _config.embed.yml
```
4. **Go to [http://localhost:4000](http://localhost:4000)**.
## Usage
### Folders structure
Here is a quick overview of the project's folders structure:
* Data:
- `_data`: Data files used throughout the site. This is mainly for settings and labels.
- `_features`: Data for every HTML and CSS features support.
- `_posts`: Data for the latest news.
- `tests`: HTML tests files to test HTML and CSS features.
* Layout:
- `_includes`: Files included in other theme files.
- `_layouts`: The main layouts of the site.
- `_sass`: Sass files. All files will be compiled into one in the `assets/css/` folder.
- `assets`: CSS, images, and JavaScript files.
## Licence
[MIT Licence](https://github.com/hteumeuleu/caniemail/blob/master/LICENSE)