Uikit::Sass:Rails

Uikit::Sass:Rails is a gem to make it super easy to use UIkit in your Rails project. It is written in Sass and compatible with the asset pipeline in Rails. You can start using Uikit::Sass:Rails in your projects by following the instructions below.

Installation

In Bundler:

gem "uikit-sass-rails"

And then execute:

$ bundle

Or install it yourself as::

$ [sudo|rvm] gem install uikit-sass-rails

Add UIkit to your CSS

Append the following line to your app/assets/stylesheets/application.css file:

/*= require uikit */

If you're planning on using Sass, then you'll want to rename application.css to application.scss. That file should then look like:

@import "uikit";

Add UIkit to your JS

Append the following line to your app/assets/javascripts/application.js file:

//= require uikit

Change UIkit Theme

If you don't want to use the default UIkit theme, just replace the uikit line in your app/assets/stylesheets/application.css file with one of the following lines:

/*= require uikit */ /* Default Theme */
/*= require uikit/gradient */ /* Gradient Theme */
/*= require uikit/almost-flat */ /* Almost-Flat Theme */

In your app/assets/stylesheets/application.scss file just replace the uikit line with one of the following lines:

@import "uikit"; // Default Theme
@import "uikit/gradient"; // Gradient Theme
@import "uikit/almost-flat"; // Almost-Flat Theme

Copyright and license

Copyright 2014 Christian Worreschk under the European Union Public Licence V. 1.1.

• UIkit is created by YOOtheme and licensed under the MIT license.
• The Font Awesome font, which is used by UIkit, is created by Dave Gandy and licensed under the SIL OFL 1.1.

Versioning

Uikit::Sass::Rails will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

• Breaking backward compatibility bumps the major (and resets the minor and patch)
• New additions, including new icons, without breaking backward compatibility bumps the minor (and resets the patch)
• Bug fixes and misc changes bumps the patch

For more information on SemVer, please visit http://semver.org.

Contributing

Uikit::Sass:Rails follows the GitFlow branching model. The master branch always reflects a production-ready state while the latest development is taking place in the develop branch.

Each time you want to work on a fix or a new feature, create a new branch based on the develop branch: git checkout -b BRANCH_NAME develop. Only pull requests to the develop branch will be merged.