docsearch
v3.8.0
무료로 문서에 검색 기능을 추가하는 가장 쉬운 방법입니다.
문서 • JavaScript 플레이그라운드 • React 플레이그라운드
DocSearch는 문서를 크롤링하고 콘텐츠를 Algolia 인덱스에 푸시하며 웹 사이트에 드롭다운 검색 환경을 제공합니다.
빛 | 어두운 |
---|---|
아직 Algolia 자격 증명이 없습니까? DocSearch에 신청하세요!
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 선택자 또는 요소일 수 있습니다.
input
아닌 container
(예: div
)를 제공해야 합니다. 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 ;
문서 읽기 →
DocSearch는 다음 저장소로 구성됩니다.
MIT