Skip to content
Merged
Changes from 1 commit
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
32 changes: 32 additions & 0 deletions guides/hidden-pages.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "How to add hidden pages"
description: "Exclude pages from your docs.json"
---

Sometimes you may want to write a page and not publish it immediately.

For content that is not strictly confidential, but isn't ready for prime time, you can add pages to your docs without referencing them in your `docs.json`. This is what is considered a "hidden page".

As long as the page is not described under any "group", "tab" or other element in the navigation section of your `docs.json`, the only way a user will be able to navigate to the page is if they know or guess the page URL.

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

If you want to take further steps to hide hidden pages' content, make sure to add `noindex: true` to the frontmatter of your page. This should prevent the page from appearing in external search results. On the other hand, if you do want hidden pages indexed for SEO purposes you can add the following setting to your `docs.json`:

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/hidden-pages.mdx#L16

Did you really mean 'frontmatter'?

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

Learn more about SEO and Sitemaps configuration in the [SEO](https://mintlify.com/docs/settings/seo#sitemaps) docs.

<Warning>
Contents of hidden pages will not be hidden from internal docs search, and may appear in AI-generated results
</Warning>

If you have certain pages that you only want exposed to specific groups of your own users, you may want to use the selective groups access available through [Personalization](https://mintlify.com/docs/settings/authentication-personalization/personalization#showing-hiding-pages).

If you have docs that you want under no circumstances exposed to the wider web, you may want to use [Authentication](https://mintlify.com/docs/settings/authentication-personalization/authentication).