Por defecto, los sitios de Starlight incluyen una búsqueda de texto completo impulsada por Pagefind, que es una herramienta de búsqueda rápida y de bajo ancho de banda para sitios estáticos.
No es necesaria ninguna configuración para habilitar la búsqueda. Construye e implementa tu sitio, luego usa la barra de búsqueda en el encabezado del sitio para encontrar contenido.
Ocultar contenido en los resultados de búsqueda
Excluye una página
Para excluir una página del índice de búsqueda, agrega pagefind: false al frontmatter de la página:
Excluye parte de una página
Pagefind ignorará el contenido dentro de un elemento con el atributo data-pagefind-ignore.
En el siguiente ejemplo, el primer párrafo se mostrará en los resultados de búsqueda, pero el contenido del <div> no:
Proveedores de búsqueda alternativos
Algolia DocSearch
Si tienes acceso al programa DocSearch de Algolia y quieres usarlo en lugar de Pagefind, puedes usar el plugin oficial Starlight DocSearch.
Agrega DocSearch a tu configuración de Starlight plugins en astro.config.mjs y pásale tu appId, apiKey e indexName de Algolia:
Con esta configuración actualizada, la barra de búsqueda de tu sitio ahora abrirá un modal de Algolia en lugar del modal de búsqueda predeterminado.
Traduciendo la UI de DocSearch
DocSearch solo proporciona cadenas de UI en inglés de forma predeterminada.
Para agregar traducciones de la UI al modal en otros idiomas, usa el sistema de internacionalización incorporado de Starlight.
Extiende la definición de la colección de contenido i18n de Starlight con el esquema de DocSearch en src/content/config.ts:
Agrega traducciones a tus archivos JSON en src/content/i18n/.
Estas son las predeterminadas en inglés que usa DocSearch: