Skip to content

Commit

Permalink
🚀 Update mode documentation. (mintlify#256)
Browse files Browse the repository at this point in the history
* Document no mode
* Give a larger section to document a single attribute
* Intentionally remove title from wide.
  • Loading branch information
mxbaylee authored Aug 22, 2024
1 parent 65c98fb commit 8fb6b46
Showing 1 changed file with 27 additions and 9 deletions.
36 changes: 27 additions & 9 deletions page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,28 +102,46 @@ iconType: "solid"
---
```

## Wide Mode
## Page Mode

You can hide the table of contents on the right side of the page. This is useful
if you don't have any headings, or you want to take advantage of the extra
horizontal space.
The Page Mode setting allows you to customize the appearance of your page. You can choose from
different modes to adjust the layout according to your needs. If no mode is specified, the page
will use the default settings.

### No Mode

If no specific mode is given, the page will default to standard settings. This means the page
will display with the default table of contents (if headings are present) and other standard
elements, providing a typical layout without any special adjustments.

```md
---
title: "Page with no ToC"
mode: "wide"
---
```

## Custom Mode
### Wide Mode

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

```md
---
title: "Page with no ToC"
mode: "wide"
---
```

### Custom Mode

*Custom Mode* provides a minimalist layout by removing all elements except for the top bar.
This mode offers a blank canvas, which is ideal for creating a "landing page" or any page where
you want a clean, distraction-free environment.


```md
---
mode: "custom"
---
```
Expand Down

0 comments on commit 8fb6b46

Please sign in to comment.