Skip to content

Latest commit

 

History

History
106 lines (59 loc) · 2.42 KB

README.md

File metadata and controls

106 lines (59 loc) · 2.42 KB
Raw

Mbox

Mbox is a Compass extension for Mozu that provides style boilerplate based on Bootstrap. It's built to be imported into your base sass files to provide access to a global grid, color palette, set of variables, and more.

Feature List

Theme

  • Background Color
  • Borders
  • Typography
  • Type Usage
  • Grid System

Objects

  • Buttons
  • Lists
  • Forms

Components

  • Blockquote
  • Jumbotron
  • Dropdowns

Utilities

  • Display & Position
  • Visibility
  • Margin & Padding

For a full list of available classes and styles, see http://www.mozu.com/style-guide

Installation

Add this line to your application's Gemfile:

gem 'mbox', :git => 'https://github.com/volusiondx/mbox.git'

And then execute:

$ bundle

Usage

Add this to your config.rb:

require 'mbox'

Add this to your base scss file:

@import 'mbox';

The mbox styles will be compiled into your css the next time you run:

$ compass watch or bundle exec compass watch

Congratulations! Now you can start using the mbox classes and variables!

Updating

To update the mbox gem and get the latest changes, run:

$ bundle update ––source mbox

Development

  1. Check out the repo

  2. Fork it

  3. Create your feature branch git checkout -b my-new-feature

  4. Commit your changes git commit -m 'Add some feature'

  5. Push to the branch git push origin my-new-feature

  6. Create new Pull Request

As you develop locally, it may be helpful to point the gemfile of your application to a local copy of mbox with this:

gem 'mbox', :path => '/local/path/to/your/mbox/'

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/volusiondx/mbox.

License

The gem is available as open source under the terms of the MIT License.