Compass Boilerplate Plugin

Lightweight HTML5 boilerplate (html5boilerplate.com/) plug-in for Compass (compass-style.org/). It contains only the pure SCSS (SASS) definitions.

For a full stack (including Javascript files & Rails helpers) please see github.com/sporkd/compass-html5-boilerplate.

Installation

Bundled:

# Add the line below to your Gemfile
gem "compass-boilerplate-plugin", :require => "compass_boilerplate"

As a simple Gem:

gem install compass-boilerplate-plugin

Usage

Basic SASS example (app/stylesheets/all.sass):

// Reset everything
@import boilerplate/reset

// Import boilerplate
@import boilerplate

// Override variables (see _base.scss for full list of options)
$font_family: Georgia, serif;
$font_size: 14px;
$link_color: #036 !default;
$link_hover_color: #000 !default;

// Include all boilerplate definitions
+boilerplate

// Include boilerplate's print definitions inline (within @media print { ... })
+boilerplate-print-inline

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.