Controle da barra lateral

A barra lateral é o painel de navegação esquerdo do seu site de documentação do Docsbook: a árvore de páginas, além de pesquisa opcional, trilhas de navegação, um seletor de idioma e ícones por página. Cada configuração aqui é uma escolha de exibição e não consome nada do saldo do seu projeto.

Configurações da barra lateral#

Como configurar a barra lateral#

1. Abra seu site de documentação.
2. Float Widget → Design → aba Barra lateral esquerda.
3. Ative ou desative as opções desejadas.
4. Salve.

Editar a barra lateral a partir da página#

A maior parte do que segue também pode ser alterada sem abrir o painel de configurações de forma alguma. No seu site de documentação, pressione Editor na barra de ferramentas e clique na entrada da barra lateral que deseja alterar. Uma pequena barra de ações aparece acima dela, oferecendo:

• Renomear — altere o rótulo mostrado na barra lateral.
• Ícone — escolha um ícone, descreva o que deseja ou remova-o.
• Análises — pergunte o que os leitores realmente fazem com essa página.

Renomear aqui altera apenas o rótulo. A página mantém seu endereço, portanto todos os links que apontam para ela — da sua própria documentação, do Google ou do blog de outra pessoa — continuam funcionando. Se quiser alterar a própria URL, renomeie o arquivo no seu repositório.

Cada ação é enviada ao chat de IA como uma solicitação, que então a aplica. Você vê o que foi solicitado e o que mudou, e pode dizer "desfaça isso" na mesma conversa.

Seletor de idioma na barra lateral#

O seletor de idioma da barra lateral é um seletor de idiomas exibido dentro do painel esquerdo para que os leitores possam alternar entre os idiomas de tradução.

Quando usar: Ative esta opção quando o cabeçalho já estiver muito cheio com outros elementos.

Observação: Ative ou o seletor da barra lateral ou o seletor de idioma do cabeçalho — não ambos. Exibi-lo em dois lugares cria redundância.

Requer que pelo menos um idioma de tradução esteja ativado. Até que isso aconteça, abrir o seletor no seu próprio site exibirá Ativar idiomas, levando você diretamente às configurações de tradução. Seus leitores verão apenas um aviso simples de Nenhum idioma adicionado. Configurar traduções →

Pesquisa na barra lateral#

A pesquisa na barra lateral é uma caixa de entrada de pesquisa exibida dentro do painel da barra lateral esquerda do seu site do Docsbook.

Esta é uma alternativa ao botão de pesquisa do cabeçalho. Alguns leitores preferem a pesquisa na barra lateral porque ela não cobre o conteúdo da página.

Mais informações sobre as opções de pesquisa →

Migalhas de navegação#

As migalhas de navegação mostram a localização da página atual na sua documentação como um caminho acima do título da página:

Home > Guides > Custom Domain

As migalhas de navegação ajudam os leitores de sites de documentação extensos a entender onde estão e a subir rapidamente um nível.

Recomendado: Mantenha as migalhas de navegação ativadas para documentações com mais de 20 páginas ou várias seções aninhadas.

Ícones da barra lateral#

Adicione um ícone ao lado de qualquer página ou pasta individual na barra lateral esquerda, para que os leitores possam visualizar a árvore em vez de depender apenas dos rótulos.

Como configurar

1. Abra seu site de documentação.
2. Widget flutuante → Design → guia Barra lateral esquerda.
3. No cartão Ícones da barra lateral, pesquise a página ou pasta que deseja marcar e escolha um ícone do lucide para ela (por exemplo, rocket, book-open).
4. Repita o procedimento para outras páginas ou pastas.
5. Salve.

O seletor oferece apenas nomes de ícones do conjunto atual de ícones do lucide — pesquisar por nome (por exemplo, "rocket", "book", "folder") restringe os resultados. A atribuição de um ícone se aplica a uma página ou pasta; atribua o ícone de uma pasta separadamente de quaisquer páginas dentro dela.

Quando usar: Os ícones ajudam os leitores a identificar rapidamente seções importantes (introdução, referência da API, FAQ) em uma barra lateral longa ou profundamente aninhada. Para um site de documentação pequeno, com apenas algumas páginas de nível superior, os ícones são opcionais.

Pastas do subcabeçalho#

As pastas do subcabeçalho transformam qualquer pasta de nível superior do repositório em sua própria aba no subcabeçalho — a fileira de abas exibida abaixo do cabeçalho principal, nas páginas de documentação. Cada pasta ativada também pode exibir um ícone do Lucide em sua aba.

Como configurar

1. Abra o site da sua documentação.
2. Acesse Float Widget → Design → a aba Cabeçalho.
3. No cartão Pastas do subcabeçalho, ative qualquer pasta de nível superior que você queira exibir como uma aba do subcabeçalho.
4. Opcionalmente, clique no botão de ícone ao lado de uma pasta ativada para escolher um ícone do Lucide para sua aba (ou em Remover ícone para limpar um ícone já definido).
5. Salve.

Uma pasta exibida no subcabeçalho também pode ser ocultada ou mantida na barra lateral esquerda de forma independente; consulte o cartão Visibilidade da pasta ao lado de Pastas do subcabeçalho para acessar essa opção.

Uma pasta é uma exceção: Primeiros passos permanece sempre na barra lateral, e sua opção fica bloqueada como ativada. É para lá que retorna um leitor que fecha a introdução antes da hora, portanto ocultá-la deixaria essa pessoa sem uma forma de voltar.

Relacionado#

• Layout e navegação do cabeçalho — a barra superior e o outro local onde o seletor de idioma pode ficar
• Opções de pesquisa — o que a caixa de pesquisa da barra lateral pesquisa
• Configurações de tradução — os idiomas oferecidos pelo seletor
• Temas — claro, escuro, sistema — o outro local onde o alternador de tema pode ficar