Skip to content

Add Tailwind v4 custom color theme example to README #396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+41 −1
Open

Add Tailwind v4 custom color theme example to README #396

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,47 @@ Note that you can't nest new `prose` instances within a `not-prose` block at thi

### Adding custom color themes

To customize the color theme beyond simple CSS overrides, you can use the JavaScript based theme API. To do that, use the `@config` directive:
To customize the color theme beyond simple CSS overrides, you can add a `@utility` directive to your CSS file.

```css
@utility prose-pink {
--tw-prose-body: var(--color-pink-800);
--tw-prose-headings: var(--color-pink-900);
--tw-prose-lead: var(--color-pink-700);
--tw-prose-links: var(--color-pink-900);
--tw-prose-bold: var(--color-pink-900);
--tw-prose-counters: var(--color-pink-600);
--tw-prose-bullets: var(--color-pink-400);
--tw-prose-hr: var(--color-pink-300);
--tw-prose-quotes: var(--color-pink-900);
--tw-prose-quote-borders: var(--color-pink-300);
--tw-prose-captions: var(--color-pink-700);
--tw-prose-code: var(--color-pink-900);
--tw-prose-pre-code: var(--color-pink-100);
--tw-prose-pre-bg: var(--color-pink-900);
--tw-prose-th-borders: var(--color-pink-300);
--tw-prose-td-borders: var(--color-pink-200);
--tw-prose-invert-body: var(--color-pink-200);
--tw-prose-invert-headings: var(--color-white);
--tw-prose-invert-lead: var(--color-pink-300);
--tw-prose-invert-links: var(--color-white);
--tw-prose-invert-bold: var(--color-white);
--tw-prose-invert-counters: var(--color-pink-400);
--tw-prose-invert-bullets: var(--color-pink-600);
--tw-prose-invert-hr: var(--color-pink-700);
--tw-prose-invert-quotes: var(--color-pink-100);
--tw-prose-invert-quote-borders: var(--color-pink-700);
--tw-prose-invert-captions: var(--color-pink-400);
--tw-prose-invert-code: var(--color-white);
--tw-prose-invert-pre-code: var(--color-pink-300);
--tw-prose-invert-pre-bg: rgb(0 0 0 / 50%);
--tw-prose-invert-th-borders: var(--color-pink-600);
--tw-prose-invert-td-borders: var(--color-pink-700);
}
```


For Tailwind v3, you can use the JavaScript based theme API. To do that, use the `@config` directive:

```diff
@import "tailwindcss";
Expand Down