3.9.0 • Published 8 months ago

@docsearch/js v3.9.0

Weekly downloads
3,172
License
MIT
Repository
github
Last release
8 months ago

@docsearch/js

JavaScript package for DocSearch, the best search experience for docs.

Installation

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

Get started

If you don’t want to use a package manager, you can use a standalone endpoint:

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

To get started, you need a container for your DocSearch component to go in. If you don’t have one already, you can insert one into your markup:

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

Then, insert DocSearch into it by calling the docsearch function and providing the container. It can be a CSS selector or an Element.

Make sure to provide a container (for example, a div), not an input. DocSearch generates a fully accessible search box for you.

import docsearch from '@docsearch/js';

import '@docsearch/css';

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

Documentation

Read documentation →

bamboosssstestesdfasdfsadfsdafvitepress-for-component-custom@easy-going/doc-themevuepress-theme-tsed2@netzoio/theme@infinitebrahmanuniverse/nolb-_doc@everything-registry/sub-chunk-249meowpress@zenphp/doczillatdpresswitepresswlthemesveafletthemekit-jsvpressvitepress-plusvitepress-dumi-themevitepress-for-componentvitepress-highlightvitepress-libraryvitepress-liudhvitepress-themevitepress-theme-docvitepress-theme-vuetomvitepress-v2vitepress-wzxvitepress-zhoulujunvitepress-theme-poseidonvite-themevant-react-clivantui-clivitepressvitepress-carbonvitepress-collapsible-sidebarkduvitehst-vitepresshairylibheader-component-for-quark-dochexo-butterfly-extjshexo-butterfly-extjs-iuxtintfract@windicss/vitepress-theme@wgoo/cli@vuepress/plugin-docsearch@vue-hooks-plus/vitepress@tzui/cli@themesberg/flowbite@vardario/svelte-ui-kit@vivy-ui/cli@vue/theme@vitesite/vitedoc-core@vitesite/vitedoc-vue3@yiddishe-kop/content-theme-docs@z9fr/vue-theme@zfui/cli@zartui/cli@zartui/mobile-clialt_vitepress@_igetter/yxtvant@a0znpm/theme-vue-base@guroads/theme@hammerfive/vitepress@cononico/vitepress@hb-webkit-dev/cli@esgraf/themess-vantui-clistellar-ui@astrojs/starlight-docsearch@brc-dd/vitepress@cenk1cenk2/nuxt-content-theme-docszart-clixxh-vuiyc-book-cliymx-cliyqh-cliyzh-themevue3-about-themevuepress-theme-tsedwangsprimevuevalaxy-theme-pressvalaxy-addon-algoliaupress@lando/vitepress-theme-default-plus@ljm-editor/cli@leafphp/docs-theme@larecipe/larecipe-ui@lewinloo/ui-cli@lengkaixin/vuicli@lincoler/theme@mussi/vitepress-theme@mychi/leaf-theme@neosjs/vitepress-theme@jeff-tian/vitepress@posva/vue-theme@pusdn/gatsby-theme-antv@sabertazimi/vitepress@pnwo222/ryt-theme@phaicom/zrchcss@panglehaoya/cli
3.9.0

8 months ago

3.8.0

11 months ago

3.8.3

9 months ago

3.8.2

10 months ago

3.8.1

10 months ago

3.7.0

12 months ago

3.6.3

12 months ago

3.6.2

1 year ago

3.6.1

1 year ago

3.6.0

2 years ago

3.5.2

2 years ago

3.4.0

2 years ago

3.3.5

2 years ago

3.5.1

2 years ago

3.5.0

2 years ago

3.3.4

2 years ago

3.3.3

3 years ago

3.3.1

3 years ago

3.3.2

3 years ago

3.2.2

3 years ago

3.3.0

3 years ago

3.2.1

3 years ago

3.2.0

3 years ago

3.1.1

3 years ago

3.1.0

3 years ago

3.0.0-alpha.50

4 years ago

3.0.0

4 years ago

3.0.0-alpha.42

4 years ago

3.0.0-alpha.41

4 years ago

3.0.0-alpha.40

4 years ago

3.0.0-alpha.38

4 years ago

3.0.0-alpha.39

4 years ago

3.0.0-alpha.37

4 years ago

3.0.0-alpha.36

5 years ago

3.0.0-alpha.35

5 years ago

3.0.0-alpha.34

5 years ago

3.0.0-alpha.33

5 years ago

3.0.0-alpha.32

5 years ago

3.0.0-alpha.31

5 years ago

3.0.0-alpha.30

5 years ago

3.0.0-alpha.29

5 years ago

1.0.0-alpha.28

5 years ago

1.0.0-alpha.27

5 years ago

1.0.0-alpha.26

5 years ago

1.0.0-alpha.25

5 years ago

1.0.0-alpha.24

5 years ago

1.0.0-alpha.23

5 years ago

1.0.0-alpha.22

5 years ago