From 5bd77497b0f16c81e5faf19ecb2cbd093a255f3f Mon Sep 17 00:00:00 2001 From: Kathryn Isabelle Lawrence Date: Mon, 14 Apr 2025 14:32:37 -0700 Subject: [PATCH 1/2] add hidden pages hidden page --- guides/hidden-pages.mdx | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 guides/hidden-pages.mdx diff --git a/guides/hidden-pages.mdx b/guides/hidden-pages.mdx new file mode 100644 index 00000000..0d14857f --- /dev/null +++ b/guides/hidden-pages.mdx @@ -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. + + +Some navigation elements like sidebars and tabs may shift or appear empty on hidden pages + + +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`: + +``` +"seo" { + "indexing": all +} +``` + +Learn more about SEO and Sitemaps configuration in the [SEO](https://mintlify.com/docs/settings/seo#sitemaps) docs. + + +Contents of hidden pages will not be hidden from internal docs search, and may appear in AI-generated results + + +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). From 95bde84be11af568ba1167b9197417f81e45c466 Mon Sep 17 00:00:00 2001 From: Kathryn Isabelle Lawrence Date: Tue, 15 Apr 2025 12:50:44 -0700 Subject: [PATCH 2/2] update section on internal search --- guides/hidden-pages.mdx | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/guides/hidden-pages.mdx b/guides/hidden-pages.mdx index 0d14857f..62f99256 100644 --- a/guides/hidden-pages.mdx +++ b/guides/hidden-pages.mdx @@ -10,10 +10,10 @@ For content that is not strictly confidential, but isn't ready for prime time, y 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 and tabs may shift or appear empty on hidden pages +Some navigation elements like sidebars, dropdowns, and tabs may shift or appear empty on hidden pages. -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`: +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" { @@ -21,11 +21,10 @@ If you want to take further steps to hide hidden pages' content, make sure to ad } ``` +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](https://mintlify.com/docs/settings/seo#sitemaps) docs. - -Contents of hidden pages will not be hidden from internal docs search, and may appear in AI-generated results - 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).