@collaborem/gaudi

A set of CSS-variables to style HTML-based Collaborem UIs consistently.


Keywords
ui, design, system, css
License
AGPL-3.0
Install
npm install @collaborem/gaudi@0.2.0

Documentation

Gaudi 🎨

Gaudi is an NPM package that provides a set of CSS-variables to style HTML-based Collaborem UIs consistently.

Use

First, add the dependency:

Yarn yarn add @collaborem/gaudi
NPM npm install @collaborem/gaudi

Then you can import it from your app. The way the CSS styles are imported depends on your bundling setup. Most Javascript bundlers have support for loading, bundling, and generating CSS bundles that get exported. All you need to do is to import Gaudi's CSS from your Javascript app:

import "@collaborem/gaudi/src/index.scss"

Set up for development

  1. Clone the repository: git clone https://github.com/collaborem/gaudi.git
  2. Install NPM dependencies with: npm install.
  3. Run: npm run website:dev.