docsearch

A maneira mais fácil de adicionar pesquisa à sua documentação – gratuitamente.

Documentação • JavaScript Playground • React Playground

---

DocSearch rastreia sua documentação, envia o conteúdo para um índice Algolia e fornece uma experiência de pesquisa suspensa em seu site.

Visualização

Luz	Escuro

Uso

Ainda não tem suas credenciais Algolia? Inscreva-se no DocSearch!

JavaScript

Instalação

yarn add @docsearch/js@3
# or
npm install @docsearch/js@3

Se não quiser usar um gerenciador de pacotes, você pode usar um endpoint independente:

 < script src =" https://cdn.jsdelivr.net/npm/@docsearch/js@3 " > </ script > 

Comece

Para começar, você precisa de um container para o componente DocSearch entrar. Se ainda não tiver um, você pode inserir um em sua marcação:

 < div id =" docsearch " > </ div >

Em seguida, insira DocSearch nele chamando a função docsearch e fornecendo o contêiner. Pode ser um seletor CSS ou um Elemento.

Certifique-se de fornecer um container (por exemplo, um div ), não um input . DocSearch gera uma caixa de pesquisa totalmente acessível para você.

 import docsearch from '@docsearch/js' ;

import '@docsearch/css' ;

docsearch ( {
  container : '#docsearch' ,
  appId : 'YOUR_APP_ID' ,
  indexName : 'YOUR_INDEX_NAME' ,
  apiKey : 'YOUR_SEARCH_API_KEY' ,
} ) ;

Reagir

Instalação

yarn add @docsearch/react@3
# or
npm install @docsearch/react@3

Se não quiser usar um gerenciador de pacotes, você pode usar um endpoint independente:

 < script src =" https://cdn.jsdelivr.net/npm/@docsearch/react@3 " > </ script > 

Comece

DocSearch gera uma caixa de pesquisa totalmente acessível para você.

 import { DocSearch } from '@docsearch/react' ;

import '@docsearch/css' ;

function App ( ) {
  return (
    < DocSearch
      appId = "YOUR_APP_ID"
      indexName = "YOUR_INDEX_NAME"
      apiKey = "YOUR_SEARCH_API_KEY"
    / >
  ) ;
}

export default App ; 

Estilo

Leia a documentação →

Projetos relacionados

DocSearch é composto pelos seguintes repositórios:

• algolia/docsearch : Código fonte do DocSearch.
• algolia/docsearch/packages/website : site e documentação do DocSearch.
• algolia/docsearch-configs : configurações de sites DocSearch que o DocSearch capacita.
• algolia/docsearch-scraper : Rastreador DocSearch que extrai dados de sua documentação.

Licença

MIT