VoteShield Styles

VoteShield CSS styles and style guide.

Install

The easiest way to install is with npm:

npm install git+ssh://[email protected]:Voteshield/voteshield-styles.git

Usage

The easiest way to use this project is include it in your SASS/SCSS file, similar to:

@import 'voteshield-styles/src/styles/index';

Since this package uses some external node modules, it is assumed that the local node_modules folder is included in the SASS/SCSS paths; this will depend on how you compile the sass.

If your project does not compile sass, you can import the built version(s) of the styles instead:

@import '@voteshield/styles/dist/styles/voteshield-styles.css';

// Minified version
@import '@voteshield/styles/dist/styles/voteshield-styles.min.css';

Contributing

See docs/CONTRIBUTING.md.

License

Licensed under the LGPL 3.0; see LICENSE.txt for details.