@carbon/colors 0.0.1-beta.5 → 10.1.1

package/CHANGELOG.md

@@ -0,0 +1,489 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [10.1.1](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v10.1.0...v10.1.1) (2019-04-13)
+
+**Note:** Version bump only for package @carbon/colors
+
+
+
+
+
+# 10.1.0 (2019-04-12)
+
+
+### Features
+
+* **sassdoc:** render Sassdoc in markdown ([#462](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/462)) ([73cea35](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/73cea35)), closes [#470](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/470)
+
+
+
+# 10.0.0 (2019-03-29)
+
+
+
+# 10.0.0-rc.0 (2019-03-27)
+
+
+
+## 0.0.1-beta.5 (2019-03-25)
+
+
+
+## 0.0.1-beta.4 (2019-03-22)
+
+
+
+## 0.0.1-beta.3 (2019-03-22)
+
+
+### Features
+
+* **test-utils:** make test-utils public ([#446](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/446)) ([7f86f8f](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/7f86f8f))
+* **theme:** add theme maps and theme mixin ([#397](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/397)) ([a91e527](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/a91e527))
+
+
+
+## 0.0.1-beta.2 (2019-03-19)
+
+
+
+## 0.0.1-beta.1 (2019-03-13)
+
+
+
+## 0.0.1-beta.0 (2019-03-07)
+
+
+
+## 0.0.1-alpha.32 (2019-02-12)
+
+
+### Bug Fixes
+
+* **colors:** change namespace to be consistent with rules ([5b58050](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/5b58050))
+
+
+### Features
+
+* **colors:** update color values ([#328](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/328)) ([83e3e92](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/83e3e92))
+
+
+
+## 0.0.1-alpha.31 (2019-01-28)
+
+
+
+## 0.0.1-alpha.30 (2019-01-22)
+
+
+### Bug Fixes
+
+* **colors:** don't quote grade values in map ([#273](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/273)) ([fa83003](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/fa83003))
+
+
+
+## 0.0.1-alpha.29 (2019-01-14)
+
+
+### Bug Fixes
+
+* **themes:** add in deprecated tokens ([#263](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/263)) ([21b9401](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/21b9401))
+
+
+
+## 0.0.1-alpha.28 (2019-01-11)
+
+
+### Bug Fixes
+
+* **colors:** add back in ibm-color-map ([#254](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/254)) ([b0ba7f8](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/b0ba7f8))
+
+
+
+## 0.0.1-alpha.27 (2019-01-10)
+
+
+### Bug Fixes
+
+* **colors:** add all colors to export ([#246](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/246)) ([8b6ac7f](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/8b6ac7f))
+* **colors:** update scss map name ([#198](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/198)) ([4dcb170](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/4dcb170))
+
+
+### Features
+
+* **bundler:** add support for scss compilation ([#222](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/222)) ([5cfcdb8](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/5cfcdb8))
+
+
+
+## 0.0.1-alpha.26 (2018-12-13)
+
+
+### Bug Fixes
+
+* **colors:** add map with grades to scss output, add black100, white0, yellow20, and orange40 vars ([#141](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/141)) ([6d6bc04](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/6d6bc04))
+
+
+
+## 0.0.1-alpha.25 (2018-12-11)
+
+
+
+## 0.0.1-alpha.24 (2018-12-07)
+
+
+
+## 0.0.1-alpha.23 (2018-12-06)
+
+
+
+## 0.0.1-alpha.22 (2018-12-04)
+
+
+
+## 0.0.1-alpha.21 (2018-12-04)
+
+
+### Features
+
+* **colors:** update color and token values ([#107](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/107)) ([63795d6](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/63795d6))
+
+
+
+## 0.0.1-alpha.20 (2018-11-29)
+
+
+
+## 0.0.1-alpha.19 (2018-11-29)
+
+
+
+## 0.0.1-alpha.18 (2018-11-28)
+
+
+
+## 0.0.1-alpha.17 (2018-11-25)
+
+
+
+## 0.0.1-alpha.16 (2018-11-21)
+
+
+
+## 0.0.1-alpha.15 (2018-11-21)
+
+
+
+## 0.0.1-alpha.14 (2018-11-20)
+
+
+
+## 0.0.1-alpha.13 (2018-11-19)
+
+
+
+## 0.0.1-alpha.12 (2018-11-18)
+
+
+
+## 0.0.1-alpha.11 (2018-11-18)
+
+
+
+## 0.0.1-alpha.10 (2018-11-18)
+
+
+
+## 0.0.1-alpha.9 (2018-11-18)
+
+
+
+## 0.0.1-alpha.8 (2018-11-18)
+
+
+### Features
+
+* add tokens alongside JavaScript output for certain packages ([#72](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/72)) ([6ca03e2](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/6ca03e2))
+
+
+
+## 0.0.1-alpha.7 (2018-11-14)
+
+
+
+## 0.0.1-alpha.5 (2018-11-14)
+
+
+
+## 0.0.1-alpha.4 (2018-11-09)
+
+
+### Bug Fixes
+
+* **colors:** update build process to output proper token names ([88d631e](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/88d631e))
+
+
+
+## 0.0.1-alpha.3 (2018-11-09)
+
+
+### Features
+
+* update for alpha.3 ([dcbfc59](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/dcbfc59))
+
+
+
+## 0.0.1-alpha.2 (2018-10-02)
+
+
+### Features
+
+* **icons-react:** add `icons-react` package ([#6](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/6)) ([43eb47c](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/43eb47c))
+* **type:** add type package ([#17](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/17)) ([904462e](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/904462e))
+
+
+
+## 0.0.1-alpha.0 (2018-08-30)
+
+
+### Features
+
+* **colors:** add colors package ([#5](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/5)) ([8b4d40e](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/8b4d40e))
+
+
+
+
+
+# [10.0.0](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v10.0.0-rc.0...v10.0.0) (2019-03-29)
+
+
+
+# [10.0.0-rc.0](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-beta.5...v10.0.0-rc.0) (2019-03-27)
+
+
+
+## [0.0.1-beta.5](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-beta.4...v0.0.1-beta.5) (2019-03-25)
+
+
+
+## [0.0.1-beta.4](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-beta.3...v0.0.1-beta.4) (2019-03-22)
+
+
+
+## [0.0.1-beta.3](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-beta.2...v0.0.1-beta.3) (2019-03-22)
+
+
+### Features
+
+* **test-utils:** make test-utils public ([#446](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/446)) ([7f86f8f](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/7f86f8f))
+* **theme:** add theme maps and theme mixin ([#397](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/397)) ([a91e527](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/a91e527))
+
+
+
+## [0.0.1-beta.2](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-beta.1...v0.0.1-beta.2) (2019-03-19)
+
+
+
+## [0.0.1-beta.1](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-beta.0...v0.0.1-beta.1) (2019-03-13)
+
+
+
+## [0.0.1-beta.0](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.32...v0.0.1-beta.0) (2019-03-07)
+
+
+
+## [0.0.1-alpha.32](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.31...v0.0.1-alpha.32) (2019-02-12)
+
+
+### Bug Fixes
+
+* **colors:** change namespace to be consistent with rules ([5b58050](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/5b58050))
+
+
+### Features
+
+* **colors:** update color values ([#328](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/328)) ([83e3e92](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/83e3e92))
+
+
+
+## [0.0.1-alpha.31](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.30...v0.0.1-alpha.31) (2019-01-28)
+
+
+
+## [0.0.1-alpha.30](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.29...v0.0.1-alpha.30) (2019-01-22)
+
+
+### Bug Fixes
+
+* **colors:** don't quote grade values in map ([#273](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/273)) ([fa83003](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/fa83003))
+
+
+
+## [0.0.1-alpha.29](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.28...v0.0.1-alpha.29) (2019-01-14)
+
+
+### Bug Fixes
+
+* **themes:** add in deprecated tokens ([#263](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/263)) ([21b9401](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/21b9401))
+
+
+
+## [0.0.1-alpha.28](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.27...v0.0.1-alpha.28) (2019-01-11)
+
+
+### Bug Fixes
+
+* **colors:** add back in ibm-color-map ([#254](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/254)) ([b0ba7f8](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/b0ba7f8))
+
+
+
+## [0.0.1-alpha.27](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.26...v0.0.1-alpha.27) (2019-01-10)
+
+
+### Bug Fixes
+
+* **colors:** add all colors to export ([#246](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/246)) ([8b6ac7f](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/8b6ac7f))
+* **colors:** update scss map name ([#198](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/198)) ([4dcb170](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/4dcb170))
+
+
+### Features
+
+* **bundler:** add support for scss compilation ([#222](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/222)) ([5cfcdb8](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/5cfcdb8))
+
+
+
+## [0.0.1-alpha.26](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.25...v0.0.1-alpha.26) (2018-12-13)
+
+
+### Bug Fixes
+
+* **colors:** add map with grades to scss output, add black100, white0, yellow20, and orange40 vars ([#141](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/141)) ([6d6bc04](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/6d6bc04))
+
+
+
+## [0.0.1-alpha.25](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.24...v0.0.1-alpha.25) (2018-12-11)
+
+
+
+## [0.0.1-alpha.24](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.23...v0.0.1-alpha.24) (2018-12-07)
+
+
+
+## [0.0.1-alpha.23](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.22...v0.0.1-alpha.23) (2018-12-06)
+
+
+
+## [0.0.1-alpha.22](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.21...v0.0.1-alpha.22) (2018-12-04)
+
+
+
+## [0.0.1-alpha.21](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.20...v0.0.1-alpha.21) (2018-12-04)
+
+
+### Features
+
+* **colors:** update color and token values ([#107](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/107)) ([63795d6](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/63795d6))
+
+
+
+## [0.0.1-alpha.20](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.19...v0.0.1-alpha.20) (2018-11-29)
+
+
+
+## [0.0.1-alpha.19](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.18...v0.0.1-alpha.19) (2018-11-29)
+
+
+
+## [0.0.1-alpha.18](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.17...v0.0.1-alpha.18) (2018-11-28)
+
+
+
+## [0.0.1-alpha.17](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.16...v0.0.1-alpha.17) (2018-11-25)
+
+
+
+## [0.0.1-alpha.16](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.15...v0.0.1-alpha.16) (2018-11-21)
+
+
+
+## [0.0.1-alpha.15](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.14...v0.0.1-alpha.15) (2018-11-21)
+
+
+
+## [0.0.1-alpha.14](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.13...v0.0.1-alpha.14) (2018-11-20)
+
+
+
+## [0.0.1-alpha.13](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.12...v0.0.1-alpha.13) (2018-11-19)
+
+
+
+## [0.0.1-alpha.12](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.11...v0.0.1-alpha.12) (2018-11-18)
+
+
+
+## [0.0.1-alpha.11](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.10...v0.0.1-alpha.11) (2018-11-18)
+
+
+
+## [0.0.1-alpha.10](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.9...v0.0.1-alpha.10) (2018-11-18)
+
+
+
+## [0.0.1-alpha.9](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.8...v0.0.1-alpha.9) (2018-11-18)
+
+
+
+## [0.0.1-alpha.8](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.7...v0.0.1-alpha.8) (2018-11-18)
+
+
+### Features
+
+* add tokens alongside JavaScript output for certain packages ([#72](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/72)) ([6ca03e2](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/6ca03e2))
+
+
+
+## [0.0.1-alpha.7](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.5...v0.0.1-alpha.7) (2018-11-14)
+
+
+
+## [0.0.1-alpha.5](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.4...v0.0.1-alpha.5) (2018-11-14)
+
+
+
+## [0.0.1-alpha.4](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.3...v0.0.1-alpha.4) (2018-11-09)
+
+
+### Bug Fixes
+
+* **colors:** update build process to output proper token names ([88d631e](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/88d631e))
+
+
+
+## [0.0.1-alpha.3](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.2...v0.0.1-alpha.3) (2018-11-09)
+
+
+### Features
+
+* update for alpha.3 ([dcbfc59](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/dcbfc59))
+
+
+
+## [0.0.1-alpha.2](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/v0.0.1-alpha.0...v0.0.1-alpha.2) (2018-10-02)
+
+
+### Features
+
+* **icons-react:** add `icons-react` package ([#6](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/6)) ([43eb47c](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/43eb47c))
+* **type:** add type package ([#17](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/17)) ([904462e](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/904462e))
+
+
+
+## [0.0.1-alpha.0](https://github.com/IBM/carbon-elements/tree/master/packages/colors/compare/8b4d40e...v0.0.1-alpha.0) (2018-08-30)
+
+
+### Features
+
+* **colors:** add colors package ([#5](https://github.com/IBM/carbon-elements/tree/master/packages/colors/issues/5)) ([8b4d40e](https://github.com/IBM/carbon-elements/tree/master/packages/colors/commit/8b4d40e))

package/README.md

@@ -32,11 +32,10 @@ In Sass, you can import the files individual by doing:
 @import '@carbon/colors/scss/colors';
 ```
 
-This file automatically includes the `carbon--colors` mixin which initializes
-all the color variables for the IBM Design Language.
+This file automatically includes the `carbon--colors` mixin which
+initializes all the color variables for the IBM Design Language.
 
-These color variables follow the naming convention: `$carbon--<swatch>-<grade>`.
-For example:
+These color variables follow the naming convention: `$carbon--<swatch>-<grade>`. For example:
 
 ```scss
 $carbon--blue-50;
@@ -45,8 +44,7 @@ $carbon--black-100;
 $carbon--white-0;
 ```
 
-You can also use the shorthand form of these colors by dropping the `carbon--`
-namespace:
+You can also use the shorthand form of these colors by dropping the `carbon--` namespace:
 
 ```scss
 $blue-50;
@@ -56,11 +54,13 @@ $white-0;
 ```
 
 _Note: the shorthand variables require that you do not have any other
-conflicting variables in your setup. Namespaced variables are always preferred
-for this reason, unless you are confident that no collisions will occur._
+conflicting variables in your setup. Namespaced variables are always
+preferred for this reason, unless you are confident that no collisions
+will occur._
 
-If you would like you choose when these variables are defined, then you can call
-the `carbon--colors` mixin directly by importing the following file:
+If you would like you choose when these variables are defined, then
+you can call the `carbon--colors` mixin directly by importing the
+following file:
 
 ```scss
 @import '@carbon/colors/scss/mixins';
@@ -69,13 +69,14 @@ the `carbon--colors` mixin directly by importing the following file:
 @include carbon--colors();
 ```
 
-Alongside the color variables detailed above, we also provide a map of colors so
-that you can programmatically use these values. This map is called
-`$carbon--colors` and each key is the name of a swatch. The value of these
-swatches is also a map, but each key is now the grade. In code, this looks like
-the following:
+Alongside the color variables detailed above, we also provide a map of
+colors so that you can programmatically use these values. This map is
+called `$carbon--colors` and each key is the name of a swatch. The
+value of these swatches is also a map, but each key is now the grade.
+In code, this looks like the following:
 
 <!-- prettier-ignore-start -->
+
 ```scss
 $carbon--colors: (
   'blue': (
@@ -84,21 +85,22 @@ $carbon--colors: (
   )
 );
 ```
+
 <!-- prettier-ignore-end -->
 
-You can include this variable by including `@carbon/colors/scss/colors` or
-calling the `carbon--colors()` mixin directly.
+You can include this variable by including `@carbon/colors/scss/colors`
+or calling the `carbon--colors()` mixin directly.
 
 #### Migrating from previous versions
 
-If you were originally using a project that had color variables defined as
-`$ibm-color__<swatch>-<grade>`, or are relying on `$ibm-color-map`, you can also
-use the entrypoint described above to access these colors. They are meant as an
-easier way to help adopt these packages. However, these variables will be removed
-in the next release of Carbon.
+If you were originally using a project that had color variables
+defined as `$ibm-color__<swatch>-<grade>`, or are relying on `$ibm-color-map`, you can also use the entrypoint described above to
+access these colors. They are meant as an easier way to help adopt
+these packages. However, these variables will be removed in the next
+release of Carbon.
 
-Similar to previous efforts, we also provide colors in the formats mentioned
-above. For example:
+Similar to previous efforts, we also provide colors in the formats
+mentioned above. For example:
 
 ```scss
 $ibm-color__blue-50;
@@ -137,6 +139,12 @@ blue[50]; // Using the `blue` object.
 warmGray100; // Using the `warmGray100` variable.
 ```
 
+## 📖 API Documentation
+
+If you're looking for `@carbon/colors` API documentation, check out:
+
+- [Sass](./docs/sass.md)
+
 ## 🙌 Contributing
 
 We're always looking for contributors to help us fix bugs, build new

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@carbon/colors",
   "description": "Colors for digital and software products using the Carbon Design System",
-  "version": "0.0.1-beta.5",
+  "version": "10.1.1",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -25,13 +25,13 @@
     "access": "public"
   },
   "scripts": {
-    "build": "yarn clean && bundler bundle src/index.js --name CarbonColors && node tasks/build.js && bundler check 'scss/*.scss'",
+    "build": "yarn clean && bundler bundle src/index.js --name CarbonColors && node tasks/build.js && bundler check 'scss/*.scss' && bundler sassdoc 'scss'",
     "clean": "rimraf css es lib umd scss"
   },
   "devDependencies": {
-    "@carbon/bundler": "0.0.1-beta.5",
-    "@carbon/cli-reporter": "0.0.1-beta.5",
-    "@carbon/test-utils": "0.0.1-beta.5",
+    "@carbon/bundler": "10.1.1",
+    "@carbon/cli-reporter": "10.0.0",
+    "@carbon/test-utils": "10.0.0",
     "change-case": "^3.0.2",
     "fs-extra": "^7.0.0",
     "node-sass": "^4.11.0",
@@ -44,5 +44,5 @@
     "sassDir": "scss",
     "needs": "^1.3.0"
   },
-  "gitHead": "eb5cb82f2f862cced404c31d69697c5b1168ecb1"
+  "gitHead": "0931cfcf4a7636d6e3f5aff3ab8d7d7f2d4ecb99"
 }

package/scss/colors.scss

@@ -1,4 +1,10 @@
 // Code generated by @carbon/colors. DO NOT EDIT.
+//
+// Copyright IBM Corp. 2018, 2018
+//
+// This source code is licensed under the Apache-2.0 license found in the
+// LICENSE file in the root directory of this source tree.
+//
 
 @import './mixins';
 

package/scss/mixins.scss

@@ -1,6 +1,15 @@
 // Code generated by @carbon/colors. DO NOT EDIT.
+//
+// Copyright IBM Corp. 2018, 2018
+//
+// This source code is licensed under the Apache-2.0 license found in the
+// LICENSE file in the root directory of this source tree.
+//
 
-// Deprecated ☠️
+/// Define color variables
+/// @access public
+/// @group @carbon/colors
+/// @deprecated Use `$carbon--colors` going forward
 @mixin ibm--colors {
   $ibm-color__black-100: #000000 !default !global;
   $ibm-color__blue-10: #edf4ff !default !global;
@@ -243,6 +252,9 @@
   ) !default !global;
 }
 
+/// Define color variables
+/// @access public
+/// @group @carbon/colors
 @mixin carbon--colors {
   $carbon--black-100: #000000 !default !global;
   $carbon--blue-10: #edf4ff !default !global;