-
Notifications
You must be signed in to change notification settings - Fork 207
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
5bd7749
add hidden pages hidden page
lawreka 95bde84
update section on internal search
lawreka 8bf7517
Merge branch 'main' into kathryn/how-to-add-hidden-pages
ethanpalm 949cab1
add page to `docs.json`
ethanpalm ca57ed5
Apply suggestions from code review
ethanpalm 2b31280
Merge branch 'main' of https://github.com/mintlify/docs into kathryn/…
lawreka File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> | ||
ethanpalm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
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`: | ||
ethanpalm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
``` | ||
"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. | ||
ethanpalm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
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). | ||
ethanpalm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.