Skip to content

How to add hidden pages #655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
31 changes: 31 additions & 0 deletions guides/hidden-pages.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
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, dropdowns, and tabs may shift or appear empty on hidden pages.
</Note>

If you want hidden pages to be indexed for SEO purposes and don't mind if their content appears in search results, you can add the following setting to your `docs.json`:

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

The settings for SEO indexing also influence whether the contents of hidden pages can appear when your docs are searched internally with the search bar. If you want to make sure hidden pages' content does not appear in SEO or internal search results, make sure to add `noindex: true` to the frontmatter of your page.

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/hidden-pages.mdx#L24

Did you really mean 'frontmatter'?

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


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