submodule.md

Vividity as a Git Submodule

You can easily use Vividity as a Git submodule.

Setup

Add Vividity to your repo:

git submodule add https://github.com/Sup2point0/vividity

If it hasn’t already, clone the submodule:

git submodule update --init

Ensure Python 3.12 or higher is installed.

Usage

If your project has this structure:

./
   vividity/
      export/
         ...
      ...
   ...
   README.md

To export colour palettes, use Python to run export. You can export to CSS, SCSS, JS, or any combination of the 3.

python vividity/export css

python vividity/export scss js