Skip to content

Commit 8fb6b46

Browse files
authored
🚀 Update mode documentation. (#256)
* Document no mode * Give a larger section to document a single attribute * Intentionally remove title from wide.
1 parent 65c98fb commit 8fb6b46

File tree

1 file changed

+27
-9
lines changed

1 file changed

+27
-9
lines changed

‎page.mdx‎

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -102,28 +102,46 @@ iconType: "solid"
102102
---
103103
```
104104

105-
## Wide Mode
105+
## Page Mode
106106

107-
You can hide the table of contents on the right side of the page. This is useful
108-
if you don't have any headings, or you want to take advantage of the extra
109-
horizontal space.
107+
The Page Mode setting allows you to customize the appearance of your page. You can choose from
108+
different modes to adjust the layout according to your needs. If no mode is specified, the page
109+
will use the default settings.
110+
111+
### No Mode
112+
113+
If no specific mode is given, the page will default to standard settings. This means the page
114+
will display with the default table of contents (if headings are present) and other standard
115+
elements, providing a typical layout without any special adjustments.
110116

111117
```md
112118
---
113119
title: "Page with no ToC"
114-
mode: "wide"
115120
---
116121
```
117122

118-
## Custom Mode
123+
### Wide Mode
119124

120-
You can remove all elements except for the top bar with custom mode. This mode
121-
provides you with a blank canvas and could be utilized to create a "landing
122-
page" for your docs.
125+
In *Wide Mode*, you can hide the table of contents (ToC) on the right side of the page. This is
126+
particularly useful if your page doesn’t have any headings or if you prefer to utilize the
127+
extra horizontal space for other content.
123128

124129
```md
125130
---
126131
title: "Page with no ToC"
132+
mode: "wide"
133+
---
134+
```
135+
136+
### Custom Mode
137+
138+
*Custom Mode* provides a minimalist layout by removing all elements except for the top bar.
139+
This mode offers a blank canvas, which is ideal for creating a "landing page" or any page where
140+
you want a clean, distraction-free environment.
141+
142+
143+
```md
144+
---
127145
mode: "custom"
128146
---
129147
```

0 commit comments

Comments
 (0)