Skip to content
This repository has been archived by the owner on Dec 23, 2018. It is now read-only.

razor-x/deck.js-material

Repository files navigation

deck.js Material Theme

Bower Version MIT License Dependency Status Build Status

Material theme for deck.js.

Description

Requirements

Bower, Bourbon, Neat, and deck.js.

Additionally, this theme uses the Roboto and Open Sans fonts, so you should provide them, e.g., with Web Font Loader.

Other dependencies are managed via Bower. Make sure your Bower components directory is in your Sass load path.

Usage

This theme assumes you have already imported Bourbon and Neat into your project. Additionally, you should import the reset theme included with deck.js.

For example, this will work with most modern build systems,

@import bourbon
@import neat
@import deck.js/themes/style/reset
@import deck.js-material

Installation

Add this as a dependency to your project using Bower with

$ bower install --save deck.js-material

Development and Testing

Source Code

The deck.js-material source is hosted on GitHub. To clone the project run

$ git clone https://github.com/razor-x/deck.js-material.git

Requirements

You will need Ruby ≥ 2 with [Bundler] and Bower.

Install the development dependencies with

$ bundle

Rake

Run rake -T to see all Rake tasks.

rake build  # Compile Sass to CSS
rake clean  # Remove build directory
rake watch  # Have Sass watch for changes

Contributing

Please submit and comment on bug reports and feature requests.

To submit a patch:

  1. Fork it (https://github.com/razor-x/deck.js-material/fork).
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Make changes.
  4. Commit your changes (git commit -am 'Add some feature').
  5. Push to the branch (git push origin my-new-feature).
  6. Create a new Pull Request.

License

This Sass package is licensed under the MIT license.

Warranty

This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.