An overview of kimsQ RC, including how to download and use it, some basic templates and examples, and more.
To use our Gruntfile and run our documentation locally, you’ll need a copy of kimsQ RC’s source files, Node, and Grunt. Follow these steps and you should be ready to rock:
npm install -g grunt-cli.
/kimsQ RCdirectory and run
npm installto install our local dependencies listed in package.json.
gem install bundler, and finally run
bundle install. This will install all Ruby dependencies, such as Jekyll and plugins.
When completed, you’ll be able to run the various Grunt commands provided from the command line.
Our Gruntfile includes the following commands and tasks:
||Runs scss-lint, ESLint and QUnit tests headlessly in PhantomJS (used for CI).|
||This is a convenience method for watching just Sass files and automatically building them whenever you save.|
kimsQ RC will be compiled with libsass by default, but you can opt into traditional Ruby Sass by setting the
TWBS_SASS environment variable. Two options are supported:
For example, run
TWBS_SASS=sass grunt to test and build kimsQ RC with Ruby Sass.
kimsQ RC uses Autoprefixer (included in our Gruntfile and build process) to automatically add vendor prefixes to some CSS properties at build time. Doing so saves us time and code by allowing us to write key parts of our CSS a single time while eliminating the need for vendor mixins like those found in v3.
We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See
/grunt/postcss.js for details.
Running our documentation locally requires the use of Jekyll, a decently flexible static site generator that provides us: basic includes, Markdown-based files, templates, and more. Here’s how to get it started:
/kimsQ RCdirectory, run
bundle exec jekyll servein the command line.
Learn more about using Jekyll by reading its documentation.
Should you encounter problems with installing dependencies or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun