Welcome to Ink 
Ink is an interface kit for quick development of web interfaces, simple to use and expand on. It uses a combination of HTML, CSS and JavaScript to offer modern solutions for building layouts, display common interface elements and implement interactive features that are content-centric and user friendly for both your audience and your designers & developers.
Read the full documentation here: https://ink.sapo.pt
Checkout our source code or report an issue here: https://github.com/sapo/Ink
If you find any inaccuracies or problems in our documentation this is the place to get them fixed.
- Running Jekyll on windows. Read and follow this how-to thoroughly and you'll save yourself hours of frustration.
- Install node.js This is required to run our build scripts.
- Install the Compass ruby gem by running following command on the command line
gem install compass - Install the grunt-cli by running the following command on the command line
npm install -g grunt-cli - Install all other dependencies by running the
npm installcommand inside Inks folder.
- Install Jekyll by running this command on a terminal:
gem install jekyll - Install the Compass ruby gem by running following command a terminal
gem install compass - Install the grunt-cli by running the following command a terminal
npm install -g grunt-cli - Install all other dependencies by running the
npm installcommand inside Inks folder.
All these commands must be ran inside Inks folder
We also have quite a few usefull grunt tasks:
grunt csscompiles the scss src into cssgrunt jsbuilds the js portion of inkgrunt docsrenenerates the js documentation and launch a local instance of the documentation site on http://localhost:4000grunt jekylllaunches a local instance of the documentation site on http://localhost:4000grunt watchwill watch the src/ folder for changes on eiher js or scss files and rebuild the lot.grunt watch:jswill watch the src/ folder for changes on js files and rebuild.grunt watch:csswill watch the src/ folder for changes on scss files and rebuild.