|
| 1 | +# Brand Guidelines |
| 2 | + |
| 3 | +This document defines the visual identity of the project. Please follow these guidelines when creating new pages, components, or assets to keep the UI consistent. |
| 4 | + |
| 5 | +## Design Principles |
| 6 | + |
| 7 | +- Keep the interface clean and minimal. |
| 8 | +- Prioritize readability over decoration. |
| 9 | +- Support both light and dark themes. |
| 10 | +- Use spacing and contrast to create hierarchy instead of excessive colors. |
| 11 | +- Avoid introducing new colors or fonts unless there is a strong reason. |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## Color Palette |
| 16 | + |
| 17 | +### Core Colors |
| 18 | + |
| 19 | +| Token | Dark | Light | |
| 20 | +| ------ | ----- | ------ | |
| 21 | +| Background | `#060606` | `#FFFFFF` | |
| 22 | +| Surface | `#141414` | `#F5F5F5` | |
| 23 | +| Surface Secondary | `#1A1A1A` | `#ECECEC` | |
| 24 | +| Border | `#2A2A2A` | `#D5D5D5` | |
| 25 | +| Text | `#FFFFFF` | `#060606` | |
| 26 | +| Secondary Text | `#888888` | `#666666` | |
| 27 | +| Muted Text | `#444444` | `#999999` | |
| 28 | +| Accent | `#F5C518` | `#D4A500` | |
| 29 | + |
| 30 | +### Semantic Colors |
| 31 | + |
| 32 | +| Purpose | Color | |
| 33 | +| -------- | ----- | |
| 34 | +| Success | `#22C55E` | |
| 35 | +| Error | `#EF4444` | |
| 36 | +| Information | `#3B82F6` | |
| 37 | + |
| 38 | +Always reference the CSS variables instead of hardcoding colors. |
| 39 | + |
| 40 | +Example: |
| 41 | + |
| 42 | +```css |
| 43 | +background: var(--surface); |
| 44 | +color: var(--text); |
| 45 | +border-color: var(--border); |
| 46 | +``` |
| 47 | + |
| 48 | +--- |
| 49 | + |
| 50 | +## Typography |
| 51 | + |
| 52 | +Font stack: |
| 53 | + |
| 54 | +``` |
| 55 | +-apple-system, |
| 56 | +BlinkMacSystemFont, |
| 57 | +"Segoe UI", |
| 58 | +Roboto, |
| 59 | +sans-serif |
| 60 | +``` |
| 61 | + |
| 62 | +### Text Sizes |
| 63 | + |
| 64 | +| Usage | Size | |
| 65 | +| ------ | ---- | |
| 66 | +| Body | 14px | |
| 67 | +| Line Height | 1.6 | |
| 68 | + |
| 69 | +Use the default font stack unless there is a project-wide decision to change it. |
| 70 | + |
| 71 | +--- |
| 72 | + |
| 73 | +## Border Radius |
| 74 | + |
| 75 | +Standard radius: |
| 76 | + |
| 77 | +``` |
| 78 | +8px |
| 79 | +``` |
| 80 | + |
| 81 | +Use the `--radius` CSS variable whenever possible. |
| 82 | + |
| 83 | +--- |
| 84 | + |
| 85 | +## Theme Support |
| 86 | + |
| 87 | +Every UI component should work correctly in both themes. |
| 88 | + |
| 89 | +Prefer using CSS variables: |
| 90 | + |
| 91 | +```css |
| 92 | +var(--bg) |
| 93 | +var(--surface) |
| 94 | +var(--surface2) |
| 95 | +var(--border) |
| 96 | +var(--text) |
| 97 | +var(--text2) |
| 98 | +var(--accent) |
| 99 | +``` |
| 100 | + |
| 101 | +Avoid hardcoded colors. |
| 102 | + |
| 103 | +--- |
| 104 | + |
| 105 | +## Links |
| 106 | + |
| 107 | +Links use the accent color. |
| 108 | + |
| 109 | +```css |
| 110 | +color: var(--accent); |
| 111 | +``` |
| 112 | + |
| 113 | +Links should remain readable in both themes. |
| 114 | + |
| 115 | +--- |
| 116 | + |
| 117 | +## Icons & Logos |
| 118 | + |
| 119 | +- Use SVG whenever possible. |
| 120 | +- Icons should inherit `currentColor` unless they intentionally use a fixed brand color. |
| 121 | +- The project logo should support both light and dark themes. |
| 122 | +- Do not stretch or distort the logo. |
| 123 | + |
| 124 | +--- |
| 125 | + |
| 126 | +## Spacing |
| 127 | + |
| 128 | +Keep spacing consistent across the project. |
| 129 | + |
| 130 | +Preferred spacing scale: |
| 131 | + |
| 132 | +``` |
| 133 | +4px |
| 134 | +8px |
| 135 | +12px |
| 136 | +16px |
| 137 | +24px |
| 138 | +32px |
| 139 | +48px |
| 140 | +64px |
| 141 | +``` |
| 142 | + |
| 143 | +--- |
| 144 | + |
| 145 | +## Scrollbars |
| 146 | + |
| 147 | +The project uses a minimal scrollbar. |
| 148 | + |
| 149 | +- Width: `5px` |
| 150 | +- Thumb: `var(--border)` |
| 151 | +- Track: `var(--bg)` |
| 152 | + |
| 153 | +--- |
| 154 | + |
| 155 | +## Before Opening a UI Pull Request |
| 156 | + |
| 157 | +- Supports both light and dark themes. |
| 158 | +- Uses existing CSS variables. |
| 159 | +- Uses the project's typography. |
| 160 | +- Maintains consistent spacing. |
| 161 | +- Does not introduce unnecessary colors. |
| 162 | +- Works across common screen sizes. |
0 commit comments