Name: seldon-gulp
Owner: Datica
Description: A Middleman 4 template using Gulp.js via the external pipeline
Forked from: joshukraine/middleman-gulp
Created: 2017-09-05 21:31:42.0
Updated: 2017-09-05 21:32:16.0
Pushed: 2017-09-16 06:13:45.0
Homepage: https://jsua.co/mm-gulp
Size: 497
Language: Ruby
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
This is a Middleman template which implements Gulp.js using the new external pipeline feature introduced in Middleman 4.
Start a new Middleman site using this template.
$ middleman init my_new_site -T joshukraine/middleman-gulp
Change into the project root and execute the setup script.
$ cd my_new_site
$ chmod +x bin/* # Make sure we can run included scripts
$ bin/setup
Start the Middleman server. Note that this will also invoke Gulp via the external pipeline.
$ bundle exec middleman server
Initialize a new Git repo.
$ git init
$ git add --all
$ git commit -m "Initial commit"
$ git remote add origin https://[your-repo-url]
$ git push -u origin master
I recommend Amazon S3 for deployment. It's very simple and surprisingly cost effective. Here's how to deploy your site to S3.
Read Amazon's guide on Hosting a Static Website
In the Gemfile, uncomment and install middleman-s3_sync
Configure your deployment configs in environments/production.rb
and environments/staging.rb
.
To deploy, run the deploy script, passing your desired environment as an argument.
$ bin/deploy production
# OR...
$ bin/deploy staging
BONUS: If you deploy with Amazon, you can get a free ssl certificate for your site!
Middleman has two default environments: development
and production
. This template is configured to run the external pipeline (Gulp in our case) in both. There are times, however, when the external pipeline should not run. Two good examples are tests and the console. We therefore define two additional environments: test
and console
.
Custom environments can be invoked on the command line with -e
flag like so:
# Start the console in the console enviroment
$ bundle exec middleman console -e console
Code for custom environments is stored in environments/<your-custom-env>.rb
. Note that custom environments can be invoked without the existence of a corresponding file in the environments/
directory. If, for example, you merely wanted to start a server without the default development
configs, you could run middleman server -e <anything-here>
.
For completeness, all five environments used in this template have corresponding files:
ronments/
console.rb
development.rb
production.rb
staging.rb
test.rb
As I initially experimented with Gulp and Middleman, it was sometimes difficult to determine which tool should handle which tasks. The problem is that, while Gulp and Middleman are very different, they have a fair amount of overlapping functionality. For example, Middleman can minify your CSS and JavaScript right out of the box. So can Gulp. Middleman can also minify your HTML, gzip your files, and automatically reload your browser using LiveReload. And Gulp can do all these things too.
So how do you decide who does what? I think most people would be inclined to have Gulp do it all. That's what it was designed for, and it makes sense to keep all these asset-related tasks in one place. However, since we're using Gulp inside of Middleman - a robust static site generator - I think there are some tasks that are better left to Middleman. Here's how I've broken it down in this template:
| Middleman | Gulp | | ————— | —————– | | HTML Templating | | | Minify HTML | | | Gzip Files | | | | Preprocess CSS | | | Minify CSS | | | Minify Javascript | | | Sourcemaps | | | Autoprefixer | | | Bundle JavaScript | | | Compress Images | | | Copy web fonts | | | Browser Reload |
Testing is done with Rspec. A few basic tests are provided as an example. Run your test suite like so:
$ bin/rspec spec/
Consider adding the following to your .bashrc
or .zshrc
file:
bundle exec middleman'
'bundle exec middleman build --clean'
'bundle exec middleman console -e console'
'bundle exec middleman server'
The following repos were very helpful in setting up this template.
Copyright © 2017 Joshua Steele. MIT License