Pages
Noções básicas
Cada página é um arquivo MDX que deve começar com --- no início e no final. Isso é usado para definir os metadados da página, como o título e a descrição.
Por exemplo, você pode definir o título desta página da seguinte forma.
Descrições
Você pode adicionar uma descrição que mostra o resumo da página abaixo do título com o metadado description.
Título da Barra Lateral
Se você quiser mostrar um título diferente na navegação, você pode definir o metadado sidebarTitle. Isso é útil se seu título for longo e você quiser algo mais curto nos links de navegação.
Ícones
Você pode definir um ícone para o item da sua barra lateral como o desta página. Você pode definir ícones usando o metadado icon.
Você pode definir ícones do Font Awesome e Lucide, dependendo da configuração da biblioteca de ícones.
Você também pode definir o tipo de ícone para ícones do Font Awesome (opcional). Se não for definido, o tipo de ícone será regular.
Páginas de API
As páginas de API permitem que você crie playgrounds interativos de API. Para criar uma página de API, você deve definir uma propriedade api ou openapi nos metadados da página.
Saiba mais sobre páginas de API visitando os guias de páginas de API.
Modo de Página
A configuração do Modo de Página permite que você personalize a aparência da sua página. Você pode escolher entre diferentes modos para ajustar o layout de acordo com suas necessidades. Se nenhum modo for especificado, a página usará as configurações padrão.
Padrão
Se nenhum modo específico for fornecido, a página usará as configurações padrão. Isso significa que a página exibirá o sumário padrão e outros elementos padrão.
Modo Amplo
No Modo Amplo, você pode ocultar o sumário (ToC) no lado direito da página. Isso é particularmente útil se sua página não tiver cabeçalhos ou se você preferir utilizar o espaço horizontal extra para mais conteúdo.
Modo Personalizado
O Modo Personalizado fornece um layout minimalista, removendo todos os elementos, exceto a barra superior. Este modo oferece uma tela em branco, ideal para criar uma “página de destino” ou qualquer página onde você deseja um ambiente limpo e sem distrações.
Modo Central
O Modo Central remove a barra lateral e o sumário, e centraliza o conteúdo da página. Este modo é ótimo para changelogs ou qualquer página onde você queira focar no conteúdo.
Links Externos
Se você quiser que a barra lateral abra uma URL externa, você pode definir o metadado url em qualquer página.
Otimização para Mecanismos de Busca
Você pode definir meta tags, como a imagem definida quando compartilhada em mídias sociais, passando-as nos metadados da sua página.
Observe que meta tags com dois pontos precisam ser envolvidas em aspas.
Veja SEO para saber mais sobre metadados de SEO.
Otimização de Busca Interna
Você também pode melhorar a descoberta de uma página específica na busca integrada fornecendo keywords nos seus metadados. Essas palavras-chave não aparecerão como parte do conteúdo da página ou nos resultados de busca, mas os usuários que pesquisarem por elas verão a página como resultado.