Algolia DocSearch

Para sitios de documentación grandes, puedes reemplazar el índice local predeterminado de FlexSearch con Algolia DocSearch. Algolia rastrea tus páginas de documentación en producción, las indexa en sus servidores en la nube y proporciona mapeo de sinónimos, analítica avanzada de búsqueda y velocidad alojada en la nube.

Algolia DocSearch es gratuito para proyectos de código abierto públicos. Puedes solicitar un contenedor en docsearch.algolia.com.

Configurando Algolia

Para habilitar Algolia, registra tus credenciales bajo la clave integrations.algolia en boltdocs.config.ts:

import { defineConfig } from 'boltdocs'

export default defineConfig({
  integrations: {
    algolia: {
      appId: 'YOUR_APP_ID',
      apiKey: 'YOUR_SEARCH_ONLY_API_KEY', // Clave pública de solo búsqueda
      indexName: 'YOUR_INDEX_NAME',
    },
  },
})

Una vez configurado, Boltdocs conecta automáticamente los componentes de la barra de búsqueda (SearchDialog y el hook useSearch) para obtener las coincidencias de consultas desde Algolia en lugar de parsear el índice offline local de FlexSearch.

Referencia de Configuración

Solución de Problemas y Entornos de Staging

Localhost no retorna resultados

Algolia DocSearch depende del rastreo de tu sitio público en producción. No indexa localhost, URLs privadas o pipelines de staging por defecto.

Solución: Si estás probando localmente, puedes comentar temporalmente el bloque de configuración algolia. Cuando falta la configuración algolia, Boltdocs automáticamente recurre a utilizar el índice offline del lado del cliente de FlexSearch para que puedas probar comportamientos de búsqueda localmente.

Analítica y Sinónimos

Para personalizar comportamientos de búsqueda, gestionar sinónimos o inspeccionar consultas que buscan los usuarios, inicia sesión en el Panel de Algolia y navega a la pestaña de Analítica de Búsqueda que corresponda a tu indexName configurado.