generator-tourbuzz-email
v0.0.2
Published
Yeoman generator
Downloads
5
Readme
Features
- ink framework
- global elements and styles
- single gulpfile
- jade and sass
- automatic inlining of css
Requirements
- node
brew install node
Homebrew is suggested to install node
File structure
project root
│ package.json
| gulpfile.js
| install.sh
└─── globals
│ └─── elements
| | | _header.jade
| | | _footer.jade
| └─── styles
| └─── ink
| | ink.scss
| | main.scss
└─── template
│ └─── app
│ | template.jade
| | template.scss
Tools used
Installation
Install yeoman
npm install -g yo
Install the Tourbuzz email generator
npm install -g generator-tourbuzz-email
In the inside the proper directory, run the generator. For example:
mkdir email && cd $_
yo tourbuzz-email
You will be asked to confirm you're intial project build. The base generator is run only once, at project creation.
Generating templates
In your project root run the subgenerator with a template name specified
yo tourbuzz-email:template <template-name>
Select a Zurb template from the list
This will give you the following new files in the project root:
template-name
└─── app
| <template-name>.jade
| <template-name>.scss
Serving files
To serve the compiled .scss
and .jade
files locally in your development enviroment
gulp serve
To build the inlined .html
file into the /dist
folder
gulp build
To serve a preview of the build
gulp serve:dist
Gulp serves up the root directory. You must navigate to the html file associated with your template.