From 40c60ecae55cb9bb6a35472a0d037b00698c1fb3 Mon Sep 17 00:00:00 2001
From: camera-2018 <40380042+camera-2018@users.noreply.github.com>
Date: Sun, 23 Jul 2023 01:44:44 +0800
Subject: [PATCH] docs: sidebar and navbar frontmatter config (#2667)
Co-authored-by: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
---
docs/reference/frontmatter-config.md | 34 ++++++++++++++++++++++++----
1 file changed, 30 insertions(+), 4 deletions(-)
diff --git a/docs/reference/frontmatter-config.md b/docs/reference/frontmatter-config.md
index 1f6ce7f1..4bbf65d5 100644
--- a/docs/reference/frontmatter-config.md
+++ b/docs/reference/frontmatter-config.md
@@ -111,6 +111,32 @@ Defines contents of home hero section when `layout` is set to `home`. More detai
Defines items to display in features section when `layout` is set to `home`. More details in [Default Theme: Home Page](./default-theme-home-page).
+### navbar
+
+- Type: `boolean`
+- Default: `true`
+
+Whether to display [navbar](./default-theme-nav).
+
+```yaml
+---
+navbar: false
+---
+```
+
+### sidebar
+
+- Type: `boolean`
+- Default: `true`
+
+Whether to display [sidebar](./default-theme-sidebar).
+
+```yaml
+---
+sidebar: false
+---
+```
+
### aside
- Type: `boolean | 'left'`
@@ -140,7 +166,7 @@ The levels of header in the outline to display for the page. It's same as [confi
- Type: `boolean`
- Default: `true`
-Whether to display [Last Updated](./default-theme-last-updated) text in the footer of the current page.
+Whether to display [last updated](./default-theme-last-updated) text in the footer of the current page.
```yaml
---
@@ -153,7 +179,7 @@ lastUpdated: false
- Type: `boolean`
- Default: `true`
-Whether to display [Edit Link](./default-theme-edit-link) in the footer of the current page.
+Whether to display [edit link](./default-theme-edit-link) in the footer of the current page.
```yaml
---
@@ -166,10 +192,10 @@ editLink: false
- Type: `boolean`
- Default: `true`
-Whether to display [Footer](./default-theme-footer) in the footer of the current page.
+Whether to display [footer](./default-theme-footer).
```yaml
---
footer: false
---
-```
\ No newline at end of file
+```