Installation

Custom Installation

Get started with styleframe in your project.

Install styleframe as a dependency

Use your favorite package manager to install styleframe in your project.

pnpm add styleframe

Initialize styleframe in your project

Use the CLI to initialize styleframe in your project.

pnpx styleframe init

Using the CLI command above, it will:

  • Install styleframe as a development dependency to your project
  • Create a new styleframe.config.ts file
  • Create a new src/styleframe.theme.ts file

Build styleframe theme files

a. Using the CLI

Use the CLI to build your theme files:

styleframe build

b. Using a script

import { build, loadConfiguration } from 'styleframe/cli';

const configuration = await loadConfiguration();

await build(configuration);

Write styleframe themes

Enjoy writing modern, maintainable, composable theme files using styleframe!