Ghink offers a quick starting point, a number of common elements and patterns used with modern websites, and some recipes to get you going.
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
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?
- _config.yml file documentation
- Snippets options and examples
- How to write a Blogpost
- See how InK works.
- How to make your own Github Page
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.