Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.79 KB

hidden-pages.mdx

File metadata and controls

31 lines (20 loc) · 1.79 KB
title description
How to add hidden pages
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.

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

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.

Learn more about SEO and Sitemaps configuration in the SEO 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.

If you have docs that you want under no circumstances exposed to the wider web, you may want to use Authentication.