Por padrão, sites Starlight incluem pesquisa de textos utilizando o Pagefind, que é uma ferramenta de pesquisa rápida e de baixo uso de banda para sites estáticos.
Nenhuma configuração é necessária para habilitar a pesquisa. Faça o build e o deploy de seu site, e utilize a barra de pesquisa no cabeçalho do site para encontrar um conteúdo.
Ocultar conteúdo no resultado da pesquisa
Para excluir uma página do seu índex de pesquisa, adicione pagefind: false ao frontmatter da página:
Exclua parte de uma página
Pagefind vai ignorar conteúdos dentro de um elemento com o atributo data-pagefind-ignore.
No exemplo a seguir, o primeiro parágrafo será exibido nos resultados de pesquisa, mas o conteúdo dentro da <div> não:
Provedores de pesquisa alternativos
Algolia DocSearch
Se você tiver acesso ao programa DocSearch da Algolia e quiser utilizá-lo no lugar do Pagefind, você pode utilizar o plugin oficial do Starlight DocSearch.
Adicione DocSearch à sua configuração de plugins do Starlight em astro.config.mjs e passe para ele seu appId, apiKey, e indexName da Algolia:
Com essa configuração atualizada, a barra de pesquisa no seu site agora vai abrir um modal da Algolia ao invés do modal de pesquisa padrão.
Traduzindo a UI do DocSearch
DocSearch só provê strings de UI em inglês por padrão.
Adicione traduções para sua linguagem à UI do modal utilizando o sistema de internacionalização integrado do Starlight.
Estenda a definição de coleções de conteúdo i18n do Starlight com o esquema do DocSearch em src/content/config.ts:
Adicione traduções aos seus arquivos JSON em src/content/i18n/.
Esses são os textos padrões em inglês utilizados pelo DocSearch: