docs: sidebar and navbar frontmatter config (#2667)

Co-authored-by: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
pull/2676/head
camera-2018 1 year ago committed by GitHub
parent b180a9e809
commit 40c60ecae5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -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). 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 <Badge type="info" text="default theme only" />
- Type: `boolean`
- Default: `true`
Whether to display [navbar](./default-theme-nav).
```yaml
---
navbar: false
---
```
### sidebar <Badge type="info" text="default theme only" />
- Type: `boolean`
- Default: `true`
Whether to display [sidebar](./default-theme-sidebar).
```yaml
---
sidebar: false
---
```
### aside <Badge type="info" text="default theme only" /> ### aside <Badge type="info" text="default theme only" />
- Type: `boolean | 'left'` - 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` - Type: `boolean`
- Default: `true` - 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 ```yaml
--- ---
@ -153,7 +179,7 @@ lastUpdated: false
- Type: `boolean` - Type: `boolean`
- Default: `true` - 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 ```yaml
--- ---
@ -166,7 +192,7 @@ editLink: false
- Type: `boolean` - Type: `boolean`
- Default: `true` - Default: `true`
Whether to display [Footer](./default-theme-footer) in the footer of the current page. Whether to display [footer](./default-theme-footer).
```yaml ```yaml
--- ---

Loading…
Cancel
Save