docsearch Download - docsearch Quellcode herunterladen

docsearch

Anderer Quellcode

v3.8.0

Herunterladen

Der einfachste Weg, Ihrer Dokumentation eine Suche hinzuzufügen – kostenlos.

Dokumentation • JavaScript Playground • React Playground

DocSearch crawlt Ihre Dokumentation, überträgt den Inhalt in einen Algolia-Index und bietet eine Dropdown-Suche auf Ihrer Website.

Vorschau

Screencast

Licht	Dunkel

Verwendung

Sie haben Ihre Algolia-Anmeldeinformationen noch nicht? Bewerben Sie sich bei DocSearch!

JavaScript

Installation

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

Wenn Sie keinen Paketmanager verwenden möchten, können Sie einen eigenständigen Endpunkt verwenden:

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

Fangen Sie an

Um zu beginnen, benötigen Sie einen container für Ihre DocSearch-Komponente. Wenn Sie noch keinen haben, können Sie einen in Ihr Markup einfügen:

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

Fügen Sie dann DocSearch ein, indem Sie die docsearch -Funktion aufrufen und den Container bereitstellen. Es kann ein CSS-Selektor oder ein Element sein.

Stellen Sie sicher, dass Sie einen container (z. B. ein div ) und kein input bereitstellen. DocSearch generiert für Sie ein vollständig zugängliches Suchfeld.

 import docsearch from '@docsearch/js' ;

import '@docsearch/css' ;

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

Reagieren

Installation

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

Wenn Sie keinen Paketmanager verwenden möchten, können Sie einen eigenständigen Endpunkt verwenden:

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

Fangen Sie an

DocSearch generiert für Sie ein vollständig zugängliches Suchfeld.

 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 ;