docsearch

Cara termudah untuk menambahkan pencarian ke dokumentasi Anda – gratis.

Dokumentasi • Taman Bermain JavaScript • Taman Bermain React

---

DocSearch merayapi dokumentasi Anda, mendorong konten ke indeks Algolia dan memberikan pengalaman pencarian dropdown di situs web Anda.

Pratinjau

Lampu	Gelap

Penggunaan

Belum memiliki kredensial Algolia Anda? Terapkan ke DocSearch!

JavaScript

Instalasi

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

Jika Anda tidak ingin menggunakan manajer paket, Anda dapat menggunakan titik akhir mandiri:

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

Mulailah

Untuk memulai, Anda memerlukan container untuk memasukkan komponen DocSearch Anda. Jika Anda belum memilikinya, Anda dapat menyisipkannya ke dalam markup Anda:

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

Kemudian, masukkan DocSearch ke dalamnya dengan memanggil fungsi docsearch dan menyediakan containernya. Ini bisa berupa pemilih CSS atau Elemen.

Pastikan untuk menyediakan container (misalnya, div ), bukan input . DocSearch menghasilkan kotak pencarian yang dapat diakses sepenuhnya untuk Anda.

 import docsearch from '@docsearch/js' ;

import '@docsearch/css' ;

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

Bereaksi

Instalasi

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

Jika Anda tidak ingin menggunakan manajer paket, Anda dapat menggunakan titik akhir mandiri:

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

Mulailah

DocSearch menghasilkan kotak pencarian yang dapat diakses sepenuhnya untuk Anda.

 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 ; 

Penataan gaya

Baca dokumentasi →

Proyek terkait

DocSearch dibuat dari repositori berikut:

• algolia/docsearch : kode sumber DocSearch.
• algolia/docsearch/packages/website : Situs web dan dokumentasi DocSearch.
• algolia/docsearch-configs : Konfigurasi situs web DocSearch yang didukung DocSearch.
• algolia/docsearch-scraper : Perayap DocSearch yang mengekstrak data dari dokumentasi Anda.

Lisensi

MIT