Skip to content

Commit 272680e

Browse files
author
Suraj Mittal
committed
chore: update readme to show how to hide pages
1 parent d1bcef2 commit 272680e

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

content/README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,68 @@ Create a similar `mdx` file inside `test-product-2` and we are done!
118118
<br />
119119
<br />
120120

121+
# Hiding pages from the sidebar
122+
123+
You can hide pages, products, or entire categories from the sidebar navigation while keeping them accessible via direct URL. This is useful for:
124+
125+
- Deprecated pages that shouldn't be discoverable but need to remain accessible for existing links
126+
- Internal or partner-specific documentation
127+
- Draft content not yet ready for public visibility
128+
- Sample/template content
129+
130+
Use the `visible_in_sidebar` property and set it to `false`.
131+
132+
---
133+
134+
### Hide a specific page
135+
136+
In the MDX file's frontmatter, set `visible_in_sidebar: false`:
137+
138+
```
139+
---
140+
sidebar_title: Hidden Page
141+
page_title: Hidden Page — Setu Docs
142+
order: 0
143+
visible_in_sidebar: false
144+
---
145+
```
146+
147+
The page will not appear in the sidebar but can still be accessed via its direct URL.
148+
149+
---
150+
151+
### Hide an entire product
152+
153+
In `endpoints.json`, set `visible_in_sidebar: false` on the product:
154+
155+
```
156+
{
157+
"name": "Hidden Product",
158+
"path": "hidden-product",
159+
"order": 0,
160+
"visible_in_sidebar": false
161+
}
162+
```
163+
164+
---
165+
166+
### Hide an entire category
167+
168+
In `endpoints.json`, set `visible_in_sidebar: false` on the category:
169+
170+
```
171+
{
172+
"name": "Hidden Category",
173+
"path": "hidden-category",
174+
"order": 4,
175+
"visible_in_sidebar": false,
176+
"children": [...]
177+
}
178+
```
179+
180+
<br />
181+
<br />
182+
121183
# Using React components in MDX files
122184

123185
List of all components and their usage can be found by visiting https://docs.setu.co/sample-category/sample-product/sample-page

0 commit comments

Comments
 (0)