Github Pages Ink boilerplate. An easy way to start a beautiful, responsive, self-hosted, blog or website.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_docs
_examples
_includes
_layouts
_posts
_scripts
assets/images
blog
cookbook
css
font
img
js
pages
.gitignore
404.html
CNAME
Gemfile
LICENSE
README.md
VERSION
_config.yml
feed.xml
index.html

README.md

Ghink

Ghink is a [github pages] 1, plus [Jekyll] 7, plus [InK] 6 boilerplate. An easy way to start a beautiful, responsive, self-hosted, blog or website.

Ghink offers a quick starting point, a number of common elements and patterns used with modern websites, and some recipes to get you going.

It's currently based on versions 3.0.0 of [Ink] 6, and 1.5.1 of [Jekyll] 7.

What is InK exactly?

[InK] 6 is a set of tools for quick development of web interfaces. It offers a fluid and responsive grid, common interface elements, interactive components, a design-first approach with ease of use and simplicity at its core. Start integrating Ink in your projects and remove the hassle of building the basics, staying free to focus on what's important.

InK provides modern responsive CSS patterns for many devices, meaning this website will work well on the desktop, smartphones or tablets.

Before you start

Before you start building your website, you need to install a few tools first.

We assume you have a Github account and are familiar with git at this point, or at leat you understand the concept of cloning, branches, pushing, pulling and committing code. If not, please take 30 minutes and read this [Guide] 2 and these [Pages] 3

Ghink uses [Github Pages] 1, which in turn uses [Jekyll] 4, a simple, blog aware static site generator. To install Jekyll in your computer, follow these steps:

sudo gem update --system
sudo gem install jekyll
sudo gem install github-pages

For more information on how to install Jekyll, check [this page] 5.

Jekyll uses the [Liquid templating] 8 system.

See it in action

We have a Ghink showroom website for you, you can use it to check on what's possible to do. Technical documentation stays here, keep reading.

Make your own Github Page in 5 minutes

We have a step by step guide for you. Read it here.

Got it. Now what?

Developing model and contributing

We use the [Git flow] 9 workflow with ghink with a few nuances. Essencially we only use the develop and gh-pages branches. Day to day development goes into the develop branch of the project, which eventually merges into the gh-pages branch, our production ready releases bucket, which in turn triggers the [Ghink website] 10, thanks to the Github Pages service.

To contribute, fork this project, then pull your changes back to me. I don't have guidelines yet, so let's see how it goes.