Skip to content

abstracthat/site-lightning

Repository files navigation

Boilerplate for static sites and static file email marketing built with Jade, Stylus and Coffeescript, using Gulp. Best web delivery practices, solid SEO, and clean/DRY structure in mind. Fast. Easy. Fun. Read more + quick start here: http://sitelightning.co/

Dependencies

Node, Gulp and Bower: npm i -g gulp bower.

Download and Run

  1. Download the boilerplate curl -L -o yoursite.zip http://github.com/abstracthat/site-lightning/archive/master.zip
  2. Unzip/rename and cd to your site's folder
  3. Run npm install && gulp

Your first install can be a little slow due to graphics library testing. You might also need some dependencies: see Sharp and imagemin.

To work on your email campaigns run gulp email.

Related Projects

This boilerplate uses Gulp Lightning. I've abstracted the library/boilerplate stuff into dependencies in that repo. This makes it easy to update your project by just bumping the version for gulp-lightning in the package.json file. The only other requirement is a local install of gulp.

Here are the related projects this boilerplate uses:

  1. Gulp Lightning
  2. Happy Grid
  3. Downbeat
  4. Stylus Lightning
  5. Rupture
  6. Axis
  7. Jade
  8. Stylus
  9. Coffeescript

TODO

Future additions...

Responsive Images

  1. add responsive image / iframe lazy loader
  2. responsive image jade mixin
  3. automatically make all formats for each file
  4. Make open graph optimized images 1200x627
  5. favicons

Markdown Parser Customizations

  1. customize Marked to parse images for classes to support lazyload
  2. customize Marked lexer for youtube, video and audio blocks

Blogging Enhancements

  1. collection.jade uses first x posts
  2. render remaining n-x posts to collection.html
  3. client loads html for remaining pages in that collection when bottom approaching.

Search

  1. Implement lunr.js
  2. autocomplete search template

IE8 support

Support IE8 with conditional vendor polyfills. https://github.com/Modernizr/Modernizr/wiki/HTML5-Cross-browser-Polyfills https://github.com/corysimmons/boy/blob/master/css/reset/reset.css

  • html5shiv
  • selectivizr
  • boxsizing.htc
  • calc() polyfill
  • css3pie (axis + htc file)
  • legacy css style sheet (rupture rasterize option)
  • png htc
  • placeholder.js
  • svg?