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
- Fork or copy this repo to your user or project
- From the
settingsrename the repo to
username.github.ionaming scheme. (For this you need to use
For Project Pages
- Create a
git checkout -b gh-pages
- Download the contents of this repo
- Replace the entire branch contents with unzipped stuff
- Add, Commit then Publish the branch to github, i.e.
git push --set-upstream origin gh-pages
To edit contents:
- edit html/md files (
_layouts/default.htmlis the base)
- edit sass and run
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)"
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
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 rubyand
sudo gem install bundlerthen
sudo bundle installonce. Mac OS X 10.11 nokogiri trouble