Skip to content

anfinil/uikit-sass-rails

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Uikit::Sass:Rails

Gem Version

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 change the uikit line in your app/assets/stylesheets/application.css file:

/*= require uikit/gradient */

or

/*= require uikit/almost-flat */

Copyright and license

Copyright 2014 MarSec under the European Union Public Licence V. 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

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

About

UIkit 2.8.0 on Sass for Rails

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages