> Vocabulary is a cohesive design system to unite the web facing Creative Commons.
Vocabulary is the code implementation of Creative Commons' Design Language. Vocabulary makes it easier to develop Creative Commons apps while ensuring a consistently familiar experience.
## Included Packages
`vocabulary` is a monorepo containing three packages:
Package | Description | |
-------------- | ------------- | -----
[@creativecommons/vocabulary](packages/vocabulary) | The main CSS component library | [![install size](https://packagephobia.com/badge?p=@creativecommons/vocabulary)](https://packagephobia.com/result?p=@creativecommons/vocabulary)
[@creativecommons/fonts](packages/fonts) | A collection of typefaces and icon fonts | [![install size](https://packagephobia.com/badge?p=@creativecommons/fonts)](https://packagephobia.com/result?p=@creativecommons/fonts)
[@creativecommons/vue-vocabulary](packages/vue-vocabulary) | Vue component library powered by the main CSS library | [![install size](https://packagephobia.com/badge?p=@creativecommons/vue-vocabulary)](https://packagephobia.com/result?p=@creativecommons/vue-vocabulary)
Packages are located in the `/packages` directory.
## Installation
You would need to have [Node.js](https://nodejs.org/en/) and [npm](https://www.npmjs.com/) installed.
To install dependencies and run the storybooks for all packages in this repository:
```bash
npm install --legacy-peer-deps
npm run setup # (optional for npm v7 & above)
npm run build
npm run storybook
```
To run the storybook for an individual package (here, vue-vocabulary):
```bash
cd packages/vue-vocabulary
npm install --legacy-peer-deps
npm run build
npm run storybook
```
## Using
To use Vocabulary in your projects, refer to [this document](https://cc-vocabulary.netlify.com/?path=/docs/vocabulary-usage--page).
## Contributing
To contribute to Vocabulary, refer to [this document](https://cc-vocabulary.netlify.com/?path=/docs/vocabulary-contribution--page).
## Versioning
Vocabulary uses [CalVer](https://calver.org/) for version numbering, in the `YYYY.M.Micro` format. `Micro` is bumped whenever there are multiple releases in a month, for example `2020.7.1` is the first release in July 2020, while `2020.7.2` is the second.
## License
Licensed under the Expat/[MIT](http://www.opensource.org/licenses/MIT) license.