Saltar al contenido principal
Versión: Estable (v4.x)

Adaptador de Docusaurus (Recomendado)

Traducción Beta No Oficial

Esta página fue traducida por PageTurner AI (beta). No está respaldada oficialmente por el proyecto. ¿Encontraste un error? Reportar problema →

Si usas Docusaurus, instala y configura @docsearch/docusaurus-adapter para obtener las últimas funcionalidades de DocSearch en tu versión actual de Docusaurus.

Por qué existe este adaptador​

Docusaurus incluye una excelente integración nativa con Algolia (@docusaurus/theme-search-algolia), pero los ciclos de lanzamiento de Docusaurus (mantenido por Meta) y DocSearch no siempre coinciden.

El adaptador de DocSearch nos permite ofrecer nuevas funcionalidades (como el panel lateral de Ask AI) sin obligar a los usuarios a esperar actualizaciones de la integración de Docusaurus.

En la práctica, esto significa:

  • Acceso más rápido a nuevas capacidades de DocSearch.

  • Mejor compatibilidad con funciones de Ask AI + panel lateral.

  • Una ruta de integración de búsqueda dedicada mantenida en el proyecto DocSearch.

Instalación​

yarn add @docsearch/docusaurus-adapter
# or
npm install @docsearch/docusaurus-adapter

Configuración​

Mantén @docusaurus/preset-classic, añade el plugin del adaptador y configura la búsqueda bajo themeConfig.docsearch (opción preferida):

docusaurus.config.mjs
export default {
  plugins: ['@docsearch/docusaurus-adapter'],
  themeConfig: {
    docsearch: {
      appId: 'YOUR_APP_ID',
      apiKey: 'YOUR_SEARCH_API_KEY',
      indexName: 'YOUR_INDEX_NAME',
      askAi: {
        assistantId: 'YOUR_ASSISTANT_ID',
        sidePanel: true,
      },
      contextualSearch: true,
    },
  },
};

Claves docsearch vs algolia​

  • themeConfig.docsearch es la clave canónica.

  • themeConfig.algolia se admite como alias para retrocompatibilidad.

  • No definas ambas claves simultáneamente.

Usar themeConfig.docsearch ayuda a evitar conflictos de validación con el tema de búsqueda nativo de Docusaurus cuando necesitas opciones nuevas como askAi.sidePanel.

Personalización de la interfaz de búsqueda (SearchBar/SearchPage)​

Si quieres personalizar el comportamiento o la interfaz de búsqueda, modifica los componentes temáticos del adaptador (@theme/SearchBar y @theme/SearchPage) desde la ruta de integración del adaptador.

Esto mantiene tus personalizaciones alineadas con las actualizaciones de DocSearch y evita acoplamiento con la implementación nativa del tema Algolia de Docusaurus.