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.
In Bundler:
gem "uikit-sass-rails"
And then execute:
$ bundle
Or install it yourself as::
$ [sudo|rvm] gem install uikit-sass-rails
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";
Append the following line to your app/assets/javascripts/application.js
file:
//= require uikit
If you don't want to use the default UIkit theme, just change the uikit line in your app/assets/stylesheets/application.css
file:
/*= require uikit/gradient */
or
/*= require uikit/almost-flat */
Copyright 2014 MarSec 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.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request