Skip to content

Commit 40c60ec

Browse files
camera-2018brc-dd
andauthored
docs: sidebar and navbar frontmatter config (vuejs#2667)
Co-authored-by: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
1 parent b180a9e commit 40c60ec

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

docs/reference/frontmatter-config.md

+30-4
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,32 @@ Defines contents of home hero section when `layout` is set to `home`. More detai
111111
112112
Defines items to display in features section when `layout` is set to `home`. More details in [Default Theme: Home Page](./default-theme-home-page).
113113
114+
### navbar <Badge type="info" text="default theme only" />
115+
116+
- Type: `boolean`
117+
- Default: `true`
118+
119+
Whether to display [navbar](./default-theme-nav).
120+
121+
```yaml
122+
---
123+
navbar: false
124+
---
125+
```
126+
127+
### sidebar <Badge type="info" text="default theme only" />
128+
129+
- Type: `boolean`
130+
- Default: `true`
131+
132+
Whether to display [sidebar](./default-theme-sidebar).
133+
134+
```yaml
135+
---
136+
sidebar: false
137+
---
138+
```
139+
114140
### aside <Badge type="info" text="default theme only" />
115141
116142
- Type: `boolean | 'left'`
@@ -140,7 +166,7 @@ The levels of header in the outline to display for the page. It's same as [confi
140166
- Type: `boolean`
141167
- Default: `true`
142168
143-
Whether to display [Last Updated](./default-theme-last-updated) text in the footer of the current page.
169+
Whether to display [last updated](./default-theme-last-updated) text in the footer of the current page.
144170
145171
```yaml
146172
---
@@ -153,7 +179,7 @@ lastUpdated: false
153179
- Type: `boolean`
154180
- Default: `true`
155181
156-
Whether to display [Edit Link](./default-theme-edit-link) in the footer of the current page.
182+
Whether to display [edit link](./default-theme-edit-link) in the footer of the current page.
157183
158184
```yaml
159185
---
@@ -166,10 +192,10 @@ editLink: false
166192
- Type: `boolean`
167193
- Default: `true`
168194
169-
Whether to display [Footer](./default-theme-footer) in the footer of the current page.
195+
Whether to display [footer](./default-theme-footer).
170196
171197
```yaml
172198
---
173199
footer: false
174200
---
175-
```
201+
```

0 commit comments

Comments
 (0)