websitetemplate-static

websitetemplate-static

A template to use for static websites based on Zurb Foundation 5, Grunt and Jekyll.

WARNING: This is no longer in maintenance. Feel free to use and/or extend, but use at your own risk.

Website Template - Static

This is a template to kick-start a statically generated website utilizing Foundation 5, Grunt and Jekyll.

Requirements

You'll need to have the following items installed before continuing.

  • Node.js: Use the installer provided on the NodeJS website.
  • Grunt: Run [sudo] npm install -g grunt-cli
  • Bower: Run [sudo] npm install -g bower
  • Ruby 2.1.1:
    • Mac OS X: Install Ruby 2.1.1 as described here
  • Jekyll: Run [sudo] gem install jekyll

Quickstart

gem install jekyll
git clone [email protected]/colincwilliams/websitetemplate-static.git
npm install && bower install

While you're working on your project, run:

grunt

to build it into _dev. To publish:

grunt publish

to publish to _public (minified JavaScript and compressed CSS).

Directory Strucutre

  • _src: Where all of the source files for your site come from.
    • scss/_settings.scss: Foundation configuration settings go in here
    • scss/app.scss: Application styles go here
  • _dev: Where the output of the site build occurs during development, without minified JS or compressed CSS for debugging.
  • _public: Where the output of the site build occurs for final publishing.

Grunt Plugins Used

Todo

These things are still a work in progress and will be completed as time allows.

  • Add copy task through grunt-contrib-copy
  • Copy jquery and foundation CSS and JS files for use, rather than using them directly
  • Make it so that grunt watch works correctly with Jekyll's serve for live development