Skip to content
This repository was archived by the owner on Mar 16, 2026. It is now read-only.

Commit 9d92693

Browse files
authored
Merge pull request #96 from mickaelzhang/hidden-document
2 parents de98d64 + 4663e30 commit 9d92693

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/docs/documentation/general/document-settings.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,14 @@ Document settings provide a way to enrich documents with metadata used to genera
1111

1212
They are defined at the top of the `.mdx` file, use YAML and can be used to customize your pages by passing this data to your theme.
1313

14-
Every document has **three** main properties that can be overriden :
14+
Every document has **four** main properties that can be overriden :
1515

1616
```markdown
1717
---
1818
name: My Document
1919
route: /custom-route
2020
menu: Documents
21+
hidden: false
2122
---
2223
```
2324

@@ -27,6 +28,7 @@ menu: Documents
2728
> If you don't pass any here, docz will create a slug using the filepath of your file as route. e.g. /src-components-my-components/
2829
2930
- `menu *(optional)*` The menu within which your document is contained. It allows you to group documents into a single menu by changing this prop.
31+
- `hidden *(optional)*` Hide the document from the menu. It can still be accessed with the link
3032

3133
## Custom properties
3234

0 commit comments

Comments
 (0)