From 8fb6b469476bda695a1400cd1b3d36effc8cfaa0 Mon Sep 17 00:00:00 2001 From: Baylee Schmeisser <119542904+mxbaylee@users.noreply.github.com> Date: Thu, 22 Aug 2024 10:30:14 -0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=80=20Update=20mode=20documentation.?= =?UTF-8?q?=20(#256)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Document no mode * Give a larger section to document a single attribute * Intentionally remove title from wide. --- page.mdx | 36 +++++++++++++++++++++++++++--------- 1 file changed, 27 insertions(+), 9 deletions(-) diff --git a/page.mdx b/page.mdx index 4815a80c..4ac69b05 100644 --- a/page.mdx +++ b/page.mdx @@ -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" --- ```