bn-styleguide

https://batterii.github.io/bn-styleguide/versions/master/

This addon/package is a guide to the global styles that we use on the batterii site.

Compatibility

• Ember.js v3.8 or above
• Ember CLI v2.13 or above
• Node.js v8 or above

Installation

ember install bn-styleguide

Local Development

If you're having trouble building, make sure ember-cli-sass is installed in the host project as a dependency (not a devDependency). You may need to move it in the host project's package.json, or run:

$ npm install --save ember-cli-sass

Usage

Refer to the docs for usage of global styles/components.

Publishing

bn-styleguide is a private npm package, so before you can publish updates to it, you'll need to do some setup. Make sure you have write access to the bn-styleguide package, and then log into npm from the command line. You can do this by running:

$ npm login

You'll then get prompts to enter your npm username, password, email, and authentication key (if you have 2FA set up). Once you're done with that, you're ready to start publishing. After cd-ing into the bn-styleguide directory, run:

$ npm publish

NOTE: Make sure you update bn-styleguide's version in its package.json file. bn-styleguide uses semver - update all versions accordingly.

Documentation Publishing

bn-styleguide is built using https://github.com/ember-learn/ember-cli-addon-docs. This provides an automated deployment to github pages. Once you've pushed your code to master, simply run ember deploy production and github pages will update with the new build.

License

This project is licensed under the MIT License.