Skip to content

Commit

Permalink
docs: update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jonambas committed Apr 6, 2024
1 parent fc816a6 commit 484ef43
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# panda-plugin-ct

Allows aliases to tokens without generating alias or component level class names.
Allows aliases to tokens without generating alias-level class names.

The plugin allows you to structure your tokens in a way makes sense to you, and does not need to adhere to Panda's token structure.

Expand Down Expand Up @@ -73,8 +73,6 @@ Which will produce:
This plugin supports aliasing to Panda's object syntax via a `value` key, just as you would define styles with conditions in Panda's theme.

```ts
// panda.config.ts

export default defineConfig({
plugins: [
pluginComponentTokens({
Expand Down Expand Up @@ -106,3 +104,12 @@ Produces:
```html
<div class="bg_red.500 text_gray.900 lg:text_gray.300" />
```

---

### Alternatives

There are alternatives to achieve the same result.

- Use Panda's `importMap` in config to reference your own alias to token mapping.
- Use `@pandabox/unplugin` to strip out and remove your own alias mapping at build time.

0 comments on commit 484ef43

Please sign in to comment.