|
1 | 1 | --- |
2 | 2 | title: Getting Started |
3 | 3 | description: This guide will help you get started with RetroUI, a retro styled UI library based on Tailwind CSS. |
4 | | -lastUpdated: 08 Oct, 2024 |
| 4 | +lastUpdated: 1 Mar, 2024 |
5 | 5 | --- |
6 | 6 |
|
7 | 7 | ### 1. Add the fonts |
@@ -32,40 +32,78 @@ Save the fonts in `global.css`: |
32 | 32 |
|
33 | 33 | <br /> |
34 | 34 |
|
35 | | -### 2. Add the theme to your tailwind.config.js file. |
| 35 | +### 2. Add your theme. |
| 36 | + |
| 37 | +Save your theme as CSS variables in `global.css`: |
| 38 | + |
| 39 | +```css |
| 40 | +:root { |
| 41 | + --muted: #606067; |
| 42 | + --background: #fff; |
| 43 | + --foreground: #000; |
| 44 | + --primary-50: #fffef0; |
| 45 | + --primary-100: #fffac2; |
| 46 | + --primary-200: #fff299; |
| 47 | + --primary-300: #ffe766; |
| 48 | + --primary-400: #ffdb33; |
| 49 | + --primary-500: #ffcc00; |
| 50 | + --primary-600: #ffb700; |
| 51 | + --primary-700: #ff9f00; |
| 52 | + --primary-800: #e68a00; |
| 53 | + --primary-900: #b36b00; |
| 54 | +} |
| 55 | +``` |
| 56 | + |
| 57 | +<br /> |
| 58 | + |
| 59 | +Connect your theme to Tailwind in `tailwind.config.ts`: |
36 | 60 |
|
37 | 61 | ```ts |
38 | 62 | import type { Config } from "tailwindcss"; |
39 | 63 |
|
40 | | -const config = { |
| 64 | +const config: Config = { |
| 65 | + content: [ |
| 66 | + "./pages/**/*.{js,ts,jsx,tsx,mdx}", |
| 67 | + "./packages/**/*.{js,ts,jsx,tsx,mdx}", |
| 68 | + "./components/**/*.{js,ts,jsx,tsx,mdx}", |
| 69 | + "./preview/**/*.{js,ts,jsx,tsx,mdx}", |
| 70 | + "./app/**/*.{js,ts,jsx,tsx,mdx}", |
| 71 | + ], |
41 | 72 | theme: { |
42 | 73 | extend: { |
| 74 | + textColor: { |
| 75 | + muted: "var(--muted)", |
| 76 | + }, |
43 | 77 | fontFamily: { |
44 | 78 | head: ["var(--font-head)"], |
45 | 79 | sans: ["var(--font-sans)"], |
46 | 80 | }, |
47 | 81 | boxShadow: { |
48 | 82 | xs: "1px 1px 0 0 #000", |
| 83 | + sm: "2px 2px 0 0 #000", |
49 | 84 | md: "3px 3px 0 0 #000", |
50 | | - "3xl": "10px 10px 0 0 #000", |
51 | 85 | }, |
52 | 86 | colors: { |
| 87 | + background: "var(--background)", |
| 88 | + foreground: "var(--foreground)", |
53 | 89 | primary: { |
54 | | - 50: "#FFFEF0", |
55 | | - 100: "#FFFAC2", |
56 | | - 200: "#FFF299", |
57 | | - 300: "#FFE766", |
58 | | - 400: "#FFDB33", |
59 | | - 500: "#FFCC00", |
60 | | - 600: "#FFB700", |
61 | | - 700: "#FF9F00", |
62 | | - 800: "#E68A00", |
63 | | - 900: "#B36B00", |
| 90 | + 50: "var(--primary-50)", |
| 91 | + 100: "var(--primary-100)", |
| 92 | + 200: "var(--primary-200)", |
| 93 | + 300: "var(--primary-300)", |
| 94 | + 400: "var(--primary-400)", |
| 95 | + 500: "var(--primary-500)", |
| 96 | + 600: "var(--primary-600)", |
| 97 | + 700: "var(--primary-700)", |
| 98 | + 800: "var(--primary-800)", |
| 99 | + 900: "var(--primary-900)", |
64 | 100 | }, |
65 | 101 | }, |
66 | 102 | }, |
67 | 103 | }, |
| 104 | + plugins: [require("tailwindcss-animate")], |
68 | 105 | }; |
| 106 | + |
69 | 107 | export default config; |
70 | 108 | ``` |
71 | 109 |
|
|
0 commit comments