caniemail
# 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. ## Sponsor  _Can I email_ is sponsored by [Resend](https://go.resend.com/caniemail). **Email for developers.** The best way to reach humans instead of spam folders. Deliver transactional and marketing emails at scale. ## 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)