https://github.com/inkdropapp/theme-dev-helpers

A helper module for creating themes for Inkdrop
https://github.com/inkdropapp/theme-dev-helpers

Last synced: 20 days ago
JSON representation

A helper module for creating themes for Inkdrop

• Host: GitHub
• URL: https://github.com/inkdropapp/theme-dev-helpers
• Owner: inkdropapp
• Created: 2024-10-15T07:11:56.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-10-31T06:36:33.000Z (about 2 months ago)
• Last Synced: 2024-12-01T06:57:34.316Z (26 days ago)
• Language: TypeScript
• Size: 163 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Theme dev helpers

A helper module for creating themes for Inkdrop.

## Requirements

- [Bun](https://bun.sh/)

## Installation

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

```bash

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.

```sh

generate-palette [options] 

```

### Parameters

You can specify the following options:

- `-a, --appearance `: 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:

```sh

generate-palette -a dark

```

## Run dev server

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

```sh

dev-server

```