@artilleryio/alpha-centauri-theme

@artilleryio/alpha-centauri-theme

Central Tailwind theme and design tokens to be shared between packages. This package shouldn't be updated without prior approval, 👮‍♂️ Consistency Police!

Installation

Simply run the following...

npm install @artilleryio/alpha-centauri-theme

...and to upgrade:

npm install @artilleryio/alpha-centauri-theme@latest

Usage

For full documentation on our design tokens and theme, visit our Visualiser.

Once you've installed the package, you will need to require it in your projects tailwind.config.js, like so:

let theme = require('@artilleryio/alpha-centauri-theme');

module.exports = {
  content: [
    './src/**/*.{js,ts,jsx,tsx}',
    './src/components/**/*.{js,ts,jsx,tsx}',
  ],
  darkMode: 'media',
  theme,
  plugins: [],
};

Contributing

The project is currently bundled together using Rollup. This makes it quite simple to build and publish changes. You will also need to be setup via NPM to be able to publish new versions of the package.

Typically, once you've run npm run lint-fix from the project root, you can build and publish by:

1. Bumping up the version number in package.json.
2. You can then simply run npm publish and this pushes the latest version of the package to NPM.

You will need to update the package wherever it is in use, in the wild (e.g. Control Panel etc.)