Skip to content

Commit e0c13ad

Browse files
lawrekaethanpalm
andauthored
How to add hidden pages (#655)
* add hidden pages hidden page * update section on internal search * add page to `docs.json` * Apply suggestions from code review --------- Co-authored-by: Ethan Palm <[email protected]>
1 parent 9ab5492 commit e0c13ad

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@
137137
"react-components",
138138
"settings/custom-scripts",
139139
"settings/seo",
140+
"guides/hidden-pages",
140141
"settings/broken-links",
141142
{
142143
"group": "Custom Subdirectory",

guides/hidden-pages.mdx

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: "Hidden pages"
3+
description: "Exclude pages from your `docs.json`"
4+
icon: "eye-closed"
5+
---
6+
7+
You can use hidden pages for content that is not strictly confidential, but isn't ready for prime time. Hidden pages are excluded from your site's navigation, so people can only access hidden pages if they know the exact URL.
8+
9+
A page is hidden until you add it to a group, tab, or other navigation element in your `docs.json`.
10+
11+
<Note>
12+
Some navigation elements like sidebars, dropdowns, and tabs may shift or appear empty on hidden pages.
13+
</Note>
14+
15+
If you want hidden pages to be indexed for SEO purposes and for their contents to appear when people search within your docs, add the following setting to your `docs.json`:
16+
17+
```
18+
"seo" {
19+
"indexing": all
20+
}
21+
```
22+
23+
If you want to exclude a specific hidden page's content from search engine and internal search results, add `noindex: true` to the frontmatter of the page.
24+
25+
If you have pages that you want only specific groups of your own users to have access to, you can use the selective groups access available through [Personalization](/settings/authentication-personalization/personalization#showing-hiding-pages).
26+
27+
If you have pages that you want to maintain strict access control to, you can use [Authentication](/settings/authentication-personalization/authentication).

0 commit comments

Comments
 (0)