Skip to content

Commit aeed254

Browse files
authored
Clarify how colors work (#1015)
* explain how colors are used * simplify colors section
1 parent 9ae5f16 commit aeed254

File tree

1 file changed

+4
-11
lines changed

1 file changed

+4
-11
lines changed

settings.mdx

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,28 +52,21 @@ See [Themes](themes) for more information.
5252
</ResponseField>
5353

5454
<ResponseField name="colors" type="object" required>
55-
The colors to use in your documentation. A primary color is required. For example:
56-
```json
57-
{
58-
"colors": {
59-
"primary": "#ff0000"
60-
}
61-
}
62-
```
55+
The colors used in your documentation. Colors are applied differently across themes. If you only provide a primary color, it will be used for all color elements.
6356

6457
<Expandable title="Colors">
6558
<ResponseField name="primary" type="string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$" required>
66-
The primary color of your theme.
59+
The primary color for your documentation. Generally used for emphasis in light mode, with some variation by theme.
6760

6861
Must be a hex code beginning with `#`.
6962
</ResponseField>
7063
<ResponseField name="light" type="string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$">
71-
Light color variant of your theme.
64+
The color used for emphasis in dark mode.
7265

7366
Must be a hex code beginning with `#`.
7467
</ResponseField>
7568
<ResponseField name="dark" type="string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$">
76-
Dark color variant of your theme.
69+
The color used for buttons and hover states across both light and dark modes, with some variation by theme.
7770

7871
Must be a hex code beginning with `#`.
7972
</ResponseField>

0 commit comments

Comments
 (0)