Ativar a pesquisa de texto completo
O Docsbook indexa todas as páginas Markdown do seu repositório e pode disponibilizar esse índice em dois lugares: um botão de pesquisa no cabeçalho e uma caixa de pesquisa na barra lateral esquerda. A pesquisa do leitor não consome nada do saldo do seu projeto — ela consulta um índice que o Docsbook já criou.
Ativar o botão de pesquisa do cabeçalho#
- Abra o site da documentação com a sessão iniciada.
- Abra a aba Float Widget → Design → Cabeçalho.
- Ative o botão de pesquisa.
- Clique em Salvar.
O botão aparece na barra superior de todas as páginas.
Ativar a pesquisa na barra lateral#
- Abra o site da documentação enquanto estiver conectado.
- Abra Float Widget → Design → a aba Barra lateral esquerda.
- Ative Pesquisar na barra lateral.
- Clique em Salvar.
A caixa aparece acima da árvore de navegação no painel esquerdo.
Escolha onde a caixa de pesquisa deve ficar#
Ambas as posições podem funcionar ao mesmo tempo. Ativar uma geralmente é suficiente.
| Posição | Ideal para | Desvantagem |
|---|---|---|
| Cabeçalho | Visitantes que acessam pela primeira vez e olham primeiro para a barra superior | Disputa espaço com os links do cabeçalho |
| Barra lateral | Leitores que já navegam pela árvore | Fica oculta em telas estreitas, onde a barra lateral é recolhida |
Se o seu cabeçalho já contém vários links, use a pesquisa na barra lateral em vez de adicionar outro controle à barra superior.
O que a pesquisa do Docsbook indexa#
A pesquisa de texto completo do Docsbook abrange todos os arquivos markdown publicados pelo site, e o índice é reconstruído quando seu repositório muda no GitHub. Não há nada para reindexar manualmente.
A pesquisa corresponde a:
- Títulos das páginas
- Títulos
- Texto do corpo
- Blocos de código, classificados abaixo do texto corrido
A pesquisa por palavras-chave é executada nesse índice e nunca chama um modelo de IA, portanto não consome o saldo do seu projeto. A pesquisa semântica — que corresponde por significado, em vez de por palavra-chave — chama um modelo e é cobrada do saldo como qualquer outro uso de IA.
Próximas etapas#
- Veja o que os leitores pesquisaram — as consultas que não retornaram nada informam qual página você deve escrever em seguida.
- Opções de conteúdo — os outros controles no mesmo painel de Design.
Cada novo projeto começa com US$ 1 de saldo, e a pesquisa dos leitores não o consome.