@vhx/adventurine

Core Vimeo OTT styling elements available for local consumption

Usage no npm install needed!

<script type="module">
  import vhxAdventurine from 'https://cdn.skypack.dev/@vhx/adventurine';
</script>

README

ADVENTURINE - Core Vimeo OTT Styles Accessible Anywhere

What is this?

Having core styles that rarely change is an integral part of our brand's look and appeal. Previously, we used Quartz to handle this- which had a lot of great elements to choose from as well as a visual component attached.

However, after refreshing the Vimeo OTT site, many of the quartz styles became obsolete. Thus, we took the best parts of Quartz, updated them to align with the Vimeo core product, and presented it in a way that made sense to use as base elements for any class in any repository!

How do I use this?

  1. Include this package in your package.json file and install it.
  2. In your index.scss file (or whatever file you are using as a manifest), include this package's partials at the top of your document. You may choose to use all of them or just a few, its up to you!
  3. In subsequent partials, add the core styles as you need in your classes.

Anything else to note?

  • This is a WIP. Everything, including this readme, will improve
  • There is a visual component to it, URL to come