You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-4Lines changed: 11 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,10 @@
1
-
# @schemavaults/theme
1
+
# 🎨 @schemavaults/theme
2
2
3
-
## About
3
+
## About 🎨
4
4
5
-
Package containing code for building TailwindCSS themes that contain SchemaVaults branding colors and shared styles.
5
+
Package containing code for building opionated TailwindCSS themes/configurations that contain SchemaVaults branding colors and shared styles.
6
+
7
+
To see the theme in action you can check out the [`@schemavaults/ui` preview site](https://ui.schemavaults.com) showcasing some styled React.js components and the features available in this theme.
6
8
7
9
## Usage
8
10
@@ -11,13 +13,15 @@ Package containing code for building TailwindCSS themes that contain SchemaVault
11
13
The generated TailwindCSS config sets colors based on CSS variables. It's important that `globals.css` is imported, so that these colors can be resolved. E.g. `var(--foreground)` and `var(--card)` become functional after this CSS import.
12
14
13
15
```javascript
16
+
// within App.jsx / layout.jsx
14
17
import"@schemavaults/theme/globals.css"
15
18
```
16
19
17
20
### Import and run the TailwindCSS Config Factory from your `tailwind.config.mjs` or `tailwind.config.ts`
You may wish to also dig deeper on the options passed to the factory / `createConfig` in order to customize the final Tailwind configuration generated. Notably, the `content` parameter to `createConfig`, if the code for styles to be generated from is not found within `./src/**/*.ts|tsx|js|jsx`!
90
96
91
-
```javascript
97
+
```typescript
98
+
// tailwind.config.ts
92
99
// ... initialize the factory somewhere
93
100
94
101
// An example demonstrating customization of where Tailwind searches for classnames
0 commit comments