Skip to content

Commit 57f22a1

Browse files
authored
Add new styling configurations (#257)
* Add new styling configurations * Adjust description for sidebar
1 parent 2bfb69c commit 57f22a1

File tree

1 file changed

+80
-35
lines changed

1 file changed

+80
-35
lines changed

settings/global.mdx

Lines changed: 80 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ settings. Learn more about the [properties](#properties) or from an
1616
Name of your company or project. Used for the global title.
1717
</ResponseField>
1818

19-
<ResponseField name="logo" type="string or object">
19+
<ResponseField name="logo" type="string or Logo">
2020
Path to logo image or object with path to "light" and "dark" mode logo images,
2121
and where the logo links to. SVG format is recommended. It does not pixelate
2222
and the file size is generally smaller.
@@ -66,15 +66,29 @@ settings. Learn more about the [properties](#properties) or from an
6666
</ResponseField>
6767

6868
<ResponseField name="theme" type={'"venus" | "quill" | "prism"'}>
69-
A preset theme configuration that changes the layout of your docs. Examples:
69+
A preset theme configuration that changes the look and feel of the project. A theme is a set of default styling configurations.
70+
71+
Examples:
7072
[Venus](https://starter-venus.mintlify.app),
7173
[Quill](https://starter-quill.mintlify.app),
7274
[Prism](https://starter-prism.mintlify.app)
7375
</ResponseField>
7476

77+
<ResponseField name="layout" type={'"topnav" | "sidenav" | "solidSidenav"'} default="topnav">
78+
The global layout style of the documentation.
79+
</ResponseField>
80+
81+
<ResponseField name="background" type="Background">
82+
Set a decorative background.
83+
<Expandable title="Background">
84+
<ResponseField name="styling" type={'"gradient" | "grid" | "windows"'}>
85+
The style of the decorative background.
86+
</ResponseField>
87+
</Expandable>
88+
</ResponseField>
89+
7590
<ResponseField name="backgroundImage" type="string">
76-
A background image to be displayed behind every page. See example with
77-
[Infisical](https://infisical.com/docs) and [FRPC](https://frpc.io).
91+
Set a custom background image to be displayed behind every page.
7892
</ResponseField>
7993

8094
<ResponseField name="modeToggle" type="ModeToggle">
@@ -88,26 +102,52 @@ settings. Learn more about the [properties](#properties) or from an
88102
Set to true to hide the dark/light mode toggle. You can combine `isHidden` with `default` to force your docs to only use light or dark mode. For example:
89103

90104
<CodeGroup>
91-
```json Only Dark Mode
92-
"modeToggle": {
93-
"default": "dark",
94-
"isHidden": true
95-
}
96-
```
97-
98-
```json Only Light Mode
99-
"modeToggle": {
100-
"default": "light",
101-
"isHidden": true
102-
}
103-
```
105+
106+
```json Only Dark Mode
107+
"modeToggle": {
108+
"default": "dark",
109+
"isHidden": true
110+
}
111+
```
112+
113+
```json Only Light Mode
114+
"modeToggle": {
115+
"default": "light",
116+
"isHidden": true
117+
}
118+
```
119+
104120
</CodeGroup>
121+
</ResponseField>
122+
</Expandable>
123+
</ResponseField>
105124

125+
<ResponseField name="sidebar" type="Sidebar">
126+
Customize the styling of components within the sidebar.
127+
<Expandable title="Sidebar">
128+
<ResponseField name="items" type={'"container" | "card" | "border" | "undecorated"'} default="container">
129+
The styling of the navigation item.
106130
</ResponseField>
131+
</Expandable>
132+
</ResponseField>
107133

134+
<ResponseField name="topbar" type="Topbar">
135+
Styling configurations for the topbar.
136+
<Expandable title="Topbar">
137+
<ResponseField name="styling" type={'"default" | "gradient"'} default="default">
138+
The styling of the navigation item.
139+
</ResponseField>
108140
</Expandable>
109141
</ResponseField>
110142

143+
<ResponseField name="search" type={'"side" | "top"'}>
144+
The location of the search bar entry.
145+
</ResponseField>
146+
147+
<ResponseField name="rounded" type={'"default" | "sharp"'}>
148+
The style of the rounded edges.
149+
</ResponseField>
150+
111151
### Structure
112152

113153
<ResponseField name="navigation" type="Navigation[]" required>
@@ -159,7 +199,12 @@ settings. Learn more about the [properties](#properties) or from an
159199
<ResponseField name="name" type="string">
160200
Text inside the button. Only required if type is a link.
161201
</ResponseField>
162-
202+
<ResponseField name="style" type={'"pill" | "roundedRectangle"'}>
203+
The style of the button.
204+
</ResponseField>
205+
<ResponseField name="arrow" type="boolean">
206+
Whether to display the arrow
207+
</ResponseField>
163208
</Expandable>
164209
</ResponseField>
165210

@@ -202,10 +247,10 @@ settings. Learn more about the [properties](#properties) or from an
202247
</Expandable>
203248
</ResponseField>
204249

205-
<ResponseField name="topAnchor" type="Object">
250+
<ResponseField name="topAnchor" type="Anchor">
206251
Override the default configurations for the top-most anchor. Note: if you have
207252
tabs configured, this does not apply.
208-
<Expandable title="Object">
253+
<Expandable title="Anchor">
209254
<ResponseField name="name" default="Documentation" type="string">
210255
The name of the top-most anchor
211256
</ResponseField>
@@ -254,12 +299,12 @@ Example:
254299
An object of social media accounts where the key:property pair represents the social media platform and the account url.
255300

256301
Example:
257-
```json
258-
{
259-
"x": "https://x.com/mintlify",
260-
"website": "https://mintlify.com"
261-
}
262-
```
302+
```json
303+
{
304+
"x": "https://x.com/mintlify",
305+
"website": "https://mintlify.com"
306+
}
307+
```
263308
<Expandable title="FooterSocials">
264309
<ResponseField name="[key]" type="string">
265310
One of the following values `website`, `facebook`, `x`, `youtube`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`
@@ -378,15 +423,15 @@ Example:
378423

379424
Examples:
380425
<CodeGroup>
381-
```json Absolute
382-
"openapi": "https://example.com/openapi.json"
383-
```
384-
```json Relative
385-
"openapi": "/openapi.json"
386-
```
387-
```json Multiple
388-
"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
389-
```
426+
```json Absolute
427+
"openapi": "https://example.com/openapi.json"
428+
```
429+
```json Relative
430+
"openapi": "/openapi.json"
431+
```
432+
```json Multiple
433+
"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
434+
```
390435
</CodeGroup>
391436

392437
</ResponseField>

0 commit comments

Comments
 (0)