Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@
"react-components",
"settings/custom-scripts",
"settings/seo",
"guides/hidden-pages",
"settings/broken-links",
{
"group": "Custom Subdirectory",
Expand Down
27 changes: 27 additions & 0 deletions guides/hidden-pages.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: "Hidden pages"
description: "Exclude pages from your `docs.json`"
icon: "eye-closed"
---

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.

A page is hidden until you add it to a group, tab, or other navigation element in your `docs.json`.

<Note>
Some navigation elements like sidebars, dropdowns, and tabs may shift or appear empty on hidden pages.
</Note>

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`:

```
"seo" {
"indexing": all
}
```

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.

Check warning on line 23 in guides/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/hidden-pages.mdx#L23

Did you really mean 'frontmatter'?

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).

If you have pages that you want to maintain strict access control to, you can use [Authentication](/settings/authentication-personalization/authentication).
Loading