@creativecommons/vocabulary

2020.11.3 • Public • Published

Vocabulary logo

Vocabulary is a cohesive design system to unite the web facing Creative Commons.

MIT license PRs welcome GitHub Actions Netlify

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 The main CSS component library install size
@creativecommons/fonts A collection of typefaces and icon fonts install size
@creativecommons/vue-vocabulary Vue component library powered by the main CSS library install size

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 --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, vocabulary):

cd packages/vocabulary
npm install --legacy-peer-deps
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.

Package Sidebar

Install

npm i @creativecommons/vocabulary

Weekly Downloads

1,669

Version

2020.11.3

License

MIT

Unpacked Size

3.02 MB

Total Files

74

Last publish

Collaborators

  • possumbilities
  • dhruvkb
  • cc-timidrobot
  • cc-open-source-bot
  • annatuma-cc