docsearch下载 - docsearch源代码下载

docsearch

其他源码

v3.8.0

下载

将搜索添加到文档的最简单方法 - 免费。

文档 • JavaScript Playground • React Playground

DocSearch 会抓取您的文档，将内容推送到 Algolia 索引，并在您的网站上提供下拉搜索体验。

预览

截屏视频

光	黑暗的

用法

还没有 Algolia 证书吗？申请文档搜索！

JavaScript

安装

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

如果您不想使用包管理器，可以使用独立端点：

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

开始使用

首先，您需要一个用于放入 DocSearch 组件的container 。如果您还没有容器，您可以将一个容器插入到您的标记中：

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

然后，通过调用docsearch函数并提供容器将 DocSearch 插入其中。它可以是 CSS 选择器或元素。

确保提供一个container （例如div ），而不是input 。 DocSearch 为您生成一个完全可访问的搜索框。

 import docsearch from '@docsearch/js' ;

import '@docsearch/css' ;

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

反应

安装

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

如果您不想使用包管理器，可以使用独立端点：

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

开始使用

DocSearch 为您生成一个完全可访问的搜索框。

 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 ;