mcastre / vocabulary

A cohesive design system & Vue component library to unify the web-facing Creative Commons

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:

• @creativecommons/vocabulary - The main CSS component library
• @creativecommons/fonts - A collection of typefaces and icon fonts
• @creativecommons/vue-vocabulary - Vue component library powered by the main CSS library

Packages are located in the /packages directory.

Installation

You would need to have Node.js and npm installed.

To install dependencies and run the storybooks for all packages in this repository:

npm install
npm run setup # (optional for npm v7 & above)
npm run build
npm run storybook

To run the storybook for an individual package (say, fonts):

cd packages/fonts
npm install
npm run build
npm run storybook

Using

To use Vocabulary in your projects, refer to this document.

Contributing

To contribute to Vocabulary, refer to this document.

Versioning

Vocabulary uses CalVer 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 license.