Páginas ocultas são removidas da navegação do seu site, mas permanecem publicamente acessíveis para quem souber a URL.
Use páginas ocultas para conteúdo que você quer manter acessível no site ou referenciar como contexto para ferramentas de IA, mas que não deve ser encontrado pela navegação.
Para conteúdo que requer controle de acesso rigoroso, configure a autenticação.
Se você quiser ocultar páginas para grupos específicos de usuários, use a personalização para controlar a visibilidade de páginas.
Uma página fica oculta se não estiver incluída na navegação do seu docs.json
. Para ocultar uma página, remova-a da estrutura de navegação.
Páginas ocultas usam a mesma estrutura de URL que páginas normais, com base no caminho do arquivo. Por exemplo, guides/hidden-page.mdx
ficará acessível em docs.yoursite.com/guides/hidden-page
.
Veja um exemplo de página oculta.
Alguns elementos de navegação, como barras laterais, menus suspensos e abas, podem aparecer vazios ou causar mudanças no layout em páginas ocultas.
Ocultando um grupo de páginas
Um grupo de páginas fica oculto se a propriedade hidden
estiver definida como true
no arquivo docs.json
:
"groups": [
{
"group": "Getting started",
"hidden": true,
"pages": [
"index",
"quickstart"
]
},
{
"group": "Guides",
"pages": [
"guides/hidden-page.mdx",
"guides/hidden-groups.mdx"
]
}
]
Neste exemplo, o grupo Getting started
está oculto, enquanto o grupo Guides
está visível.
Você também pode ocultar uma guia adicionando a propriedade hidden
ao arquivo docs.json
:
"tabs": [
{
"tab": "Home",
"hidden": true,
"pages": [
"index",
"quickstart"
]
}
]
Pesquisa, SEO e indexação por IA
Por padrão, páginas ocultas ficam fora da indexação por mecanismos de busca, da pesquisa interna na sua documentação e do contexto do Assistente de IA. Para incluir páginas ocultas nos resultados de pesquisa e como contexto para o assistente, adicione a propriedade seo
ao seu docs.json
:
"seo": {
"indexing": "all"
}
Para excluir uma página específica, adicione noindex: "true"
ao frontmatter dela.