https://github.com/dan-leech/laravel-elixir-foundation-emails
Laravel Foundation Emails 2 integration
https://github.com/dan-leech/laravel-elixir-foundation-emails
foundation-emails integration laravel laravel-elixir
Last synced: about 2 months ago
JSON representation
Laravel Foundation Emails 2 integration
- Host: GitHub
- URL: https://github.com/dan-leech/laravel-elixir-foundation-emails
- Owner: dan-leech
- License: mit
- Created: 2017-01-24T13:53:06.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-09T19:57:20.000Z (almost 9 years ago)
- Last Synced: 2025-10-04T00:49:39.699Z (8 months ago)
- Topics: foundation-emails, integration, laravel, laravel-elixir
- Language: JavaScript
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Elixir Foundation Emails 2 Integration
This extension brings Foundation Emails 2 support to Laravel Elixir, version 6 and up.
## Step 1: Install
```js
npm install laravel-elixir-foundation-emails --save-dev
```
## Step 2: Usage
The `foundationEmails` method may be used to compile email blade templates, sass, images into blade views.
```javascript
elixir(function(mix) {
mix.foundationEmails();
});
```
Default options are:
```javascript
options = {
sass: 'resources/assets/sass/emails/email.scss',
source: 'resources/emails',
views: 'resources/views/emails',
images: 'resources/emails/images',
imagesDist: 'public/images/emails',
publicCss: 'public/css',
compiled: 'resources/emails/dist'
};
```
- `sass:` email.scss - compiled into email.css, saves to `compiled` and `publicCss`.
- `source` blade emails folder before inky and inlining css
- `views` destination - compiled templates for use in Laravel
- `images` images folder before minifing
- `imagesDist` images ready for use
- `compiled` tmprorary folder
To choose a different options or rewrite one of them you can use method argument.
```javascript
elixir(function(mix) {
mix.foundationEmails({
copiled: 'public/compiled/emails'
});
});
```
Or can use `foundation-emails.config.js` file in your project root. Example:
```javascript
module.exports = {
sass: 'resources/assets/sass/emails/email.scss',
source: 'resources/emails',
views: 'resources/views/emails',
images: 'resources/emails/images',
imagesDist: 'public/images/emails',
publicCss: 'public/css',
compiled: 'resources/emails/dist'
};
```
## Step 3: Plugins
If you've created a plugin, and need to hook your own FoundationEmails config into Elixir's defaults, add the following to your script:
```js
Elixir.foundationEmails.mergeConfig({
sass: 'resources/assets/sass/emails/email.scss',
});
```
`Elixir.foundationEmails.mergeConfig(newConfig)` will recursively merge your provided configuration with ours.
## Notices
Current plugin freezes gulp flow until all it's works will be done. Because I can't find better way to run several streams in elixir gulp task without callback.
Css inliner removes all `` tags in production mode.
To add styles to compiled styles in head put it into `