Quickly start a Jekyll website powerd by foundation/sass using github pages!


NOTE: Check out my new jekyll-foundation-6-starter

Start a github pages website powerd by Jekyll using Foundation/SCSS in under 5 minutes!

What it is.

Ever wanted a simple but nice looking responsive website as your project page or page for your repo? Are you in a hackathon needing to put up a working website in minutes? I do. Here is what I do, and I am sharing for you to use it, free. Free as in free speach AND free beer.

You can see the working example site here

For User & Organization Pages

See github documentation

  1. Fork or copy this repo to your user or project
  2. From the settings rename the repo to naming scheme.

For Project Pages

See github documentation

  1. Create a gh-pages branch, i.e. git checkout -b gh-pages
  2. Download the contents of this repo
  3. Replace the entire branch contents with unzipped stuff
  4. Add, Commit then Publish the branch to github, i.e. git push --set-upstream origin gh-pages

To edit contents:

  1. edit _config.yml
  2. edit html/md files (hint: _layouts/default.html is the base)
  3. edit sass and run grunt (hint: Try editing scss/_stettings.scss)
  4. edit _include/nav.html

Use at your own resk, and follw licence restriction of each products used. Most are MIT (OK to use commercially).

Useful command:

This assumes you have grunt and bower installed. Make sure you have npm, and have ran npm install -g bower grunt-cli to install bower and grunt globally.

Run grunt to compile css from sass by simply run grunt from your terminal within your repo. It will launch watch by default. control-c to stop. If you only want the css compiled once, run grunt sass

To run jekyll locally to test your website while developing, run bundle exec jekyll serve --watch (requires ruby)

Your website should be viewable by going to localhost:4000

Github's doc on how to use Jekyll on Github Pages is also helpful.

For more on Foundation stuff that I am using, see Foundation documentation

Special Thanks

Special thanks to HTML 5 Boilerplate whose code I have based this on.

@kionoshp's padding-margin. Because it has become part of every site that I manage.

and Font Awesome for bing awesome.