Skip to content

inkdropapp/theme-dev-helpers

Repository files navigation

Theme dev helpers

A helper module for creating themes for Inkdrop.

Requirements

Installation

You can install the @inkdropapp/theme-dev-helpers in your theme project:

bun i -D @inkdropapp/theme-dev-helpers

Generate Palette

It extracts computed values of theme-related CSS variables from CSS files, and outputs to the specified path.

generate-palette [options] <theme-name>

Parameters

You can specify the following options:

  • -a, --appearance <light/dark>: Force the UI appearance ("light" or "dark")
  • -o, --output: The file path where the extracted variables will be saved (default: ./palette.json).

Example

If your theme package name doesn't include 'dark' but it is a dark mode:

generate-palette -a dark

Run dev server

It provides a simple UI to preview your theme with hot-reloading.

dev-server

Development

Dependencies are managed with pnpm, and Bun is the runtime used to run the CLIs and tests.

pnpm install      # install dependencies
pnpm format       # format with oxfmt
pnpm lint         # lint with oxlint
pnpm typecheck    # type-check with tsc
pnpm test         # run unit tests (bun test)

About

A helper module for creating themes for Inkdrop

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors