Translate

Habilitando la búsqueda

Docusaurus admite la búsqueda usando Algolia DocSearch. Una vez que haya configurado su sitio, ingrese la información de su sitio para que Algolia rastree las páginas de documentación de su sitio web. Algolia le enviará una clave API y un nombre de index para su sitio.

Habilitando la barra de búsqueda

Ingrese su clave API de búsqueda y su nombre de index en siteConfig.js en el sección algolia para permitir la búsqueda de su sitio.

const siteConfig = {
  ...
  algolia: {
    apiKey: "my-search-only-api-key-1234",
    indexName: "my-index-name"
  },
  ...
}

Opciones adicionales de búsqueda

También puede especificar opciones de búsqueda adicionales utilizadas por Algolia usando un campo algoliaOptions en algolia. Esto puede ser útil si desea proporcionar diferentes resultados de búsqueda para las diferentes versiones o idiomas de sus documentos. Cualquier suceso de "VERSIÓN" o "IDIOMA" será reemplazada por la versión o el idioma de la página actual, respectivamente. Más detalles sobre las opciones de búsqueda pueden ser encontrado aquí.

const siteConfig = {
  ...
  algolia: {
    ...
    algoliaOptions: {
      facetFilters: [ "tags:VERSION" ],
      hitsPerPage: 5
    }
  },
}

Controlar la ubicación de la barra de búsqueda

Por defecto, la barra de búsqueda será el elemento situado más a la derecha en la barra de navegación superior.

Si desea cambiar la ubicación predeterminada, agregue elsearchBar en el campo headerLinks del campo siteConfig.js en la ubicación deseada. Por ejemplo, es posible que desee la barra de búsqueda entre sus enlaces internos y externos.

const siteConfig = {
  ...
  headerLinks: [
    {...}
    {...}
    { search: true }
    {...}
    {...}
  ],
  ...
}

Habilitando la barra de búsqueda

Para deshabilitar la barra de búsqueda, comente (recomendado) o elimine la sección de algolia en el archivo siteConfig.js.

Además, si ha personalizado la ubicación de la barra de búsqueda en headerLinks, establezca search: false.