Search

The default theme supports Algolia DocSearch through docsearch and custom search components through search, including @sveltepress/meilisearch.

Algolia DocSearch

Pass a docsearch config object to defaultTheme to enable Algolia DocSearch in the navbar.

Required fields are appId, apiKey, and indexName. Every other DocSearch option is also accepted.

import {  } from '@sveltepress/theme-default'
import {  } from '@sveltepress/vite'
import {  } from 'vite'

export default ({
  : [
    ({
      : ({
        : {
          : 'YOUR_APP_ID',
          : 'YOUR_SEARCH_API_KEY',
          : 'YOUR_INDEX_NAME',
        },
      }),
    }),
  ],
})

Meilisearch

@sveltepress/meilisearch is the supported Meilisearch search component. Install it first:

npm install --save @sveltepress/meilisearch

Create a wrapper that provides your Meilisearch connection settings:

<script lang="ts">
  import  from '@sveltepress/meilisearch/Search.svelte'
</script>

<
  ="https://search.example.com"
  ="YOUR_SEARCH_ONLY_KEY"
  ="docs"
/>

Then pass the wrapper path to the default theme's custom-search hook:

import {  } from '@sveltepress/theme-default'

({
  : '/src/lib/MeilisearchSearch.svelte',
})

The component queries an existing Meilisearch index; it does not build the index for you. Each record should provide id, title, content, and either url or path. Use a search-only API key in browser code.

For another search provider, implement the same search hook with your own Svelte wrapper. If both search and docsearch are configured, search takes precedence.