Translate

Enabling Search

O Docusaurus oferece suporte a pesquisa usando o Algolia DocSearch. Assim que seu site estiver publicado, você poderá enviá-lo para o DocSearch. Em seguida, o Algolia vai te enviar credenciais que você pode adicionar ao seu siteConfig.js.

Funciona assim: o DocSearch vasculha o conteúdo do seu site a cada 24 horas e coloca tudo que ele encontrou em um índice de pesquisa do Algolia. Esse conteúdo poderá então ser consultado diretamente do seu front-end usando a API do Algolia. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). Este serviço é gratuito.

Ativando a barra de pesquisa

Para ativar a pesquisa no seu site, basta salvar a sua chave de API e o nome do seu índice (enviados pelo Algolia) no siteConfig.js, na seção algolia.

const siteConfig = {
  ...
  algolia: {
    apiKey: 'my-api-key',
    indexName: 'my-index-name',
    appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
    algoliaOptions: {} // Optional, if provided by Algolia
  },
  ...
};

Opções adicionais de pesquisa

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. Isso pode ser útil caso você queira fornecer resultados de busca diferentes para as diferentes versões e idiomas da sua documentação. Todas as ocorrências de "VERSION" ou "LANGUAGE" serão substituídas pela versão ou idioma da página atual, respectivamente. Mais detalhes sobre as opções de pesquisa podem ser encontrados aqui.

const siteConfig = {
  ...
  algolia: {
    ...
    algoliaOptions: {
      facetFilters: [ "language:LANGUAGE", "version:VERSION" ]
    }
  },
};

Algolia might provide you with extra search options. Se fornecer, você deve adicioná-las ao objeto algoliaOptions.

Controlando o local da barra de pesquisa

Por padrão, a barra de pesquisa será o elemento mais à direita no menu de navegação superior.

Se você quiser mudar o local padrão, adicione a flag searchBar no campo headerLinks do siteConfig.js, na posição de sua preferência. Por exemplo, você pode querer que a barra de pesquisa fique entre seus links internos e externos.

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

Customizing the placeholder

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

const siteConfig = {
  ...
  algolia: {
    ...
    placeholder: 'Ask me something'
  },
};

Desativando a barra de pesquisa

Para desativar a barra de pesquisa, comente (recomendado) ou apague a seção algolia no arquivo siteConfig.js.

Além disso, se você tiver personalizado a localização da barra de pesquisa em headerLinks, defina search: false.