jekyll-foundation-6-starter

Start a github pages website powered 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 speech 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 username.github.io naming scheme. (For this you need to use master branch)

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 (_layouts/default.html is the base)
3. edit sass and run gulp (Try editing scss/_stettings.scss)
4. edit _include/nav.html

Use at your own risk, and follow license restriction of each products used. Most are MIT (OK to use commercially).

Tools used, and useful commands

If you don't have it, install node.js. Easiest way it to use Homebrew by ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" then brew install node and install npm and gulp globally by running sudo npm install npm gulp -g

Run gulp to compile css from sass by simply run gulp 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 gulp 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.

• You may have to run brew install ruby and sudo gem install bundler then sudo bundle install once. Mac OS X 10.11 nokogiri trouble

---

LICENSE

All articles and writing are licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International license. For the full text of the license, please see the Creative Commons site.

All other code in this repo is under the MIT License.