mkdocs-material/docs/guides/setting-up-site-search.md

template
overrides/main.html

Setting up site search

Material for MkDocs provides a great, client-side search implementation, omitting the need for the integation of third-party services, which might violate data privacy regulations. Furthermore, with some effort, search can be made available offline.

Configuration

Built-in search

:octicons-file-code-24: Source · :octicons-cpu-24: Plugin

The built-in search plugin integrates seamlessly with Material for MkDocs, adding multilingual client-side search with lunr and lunr-languages. It's enabled by default, but must be re-added to mkdocs.yml when other plugins are used:

plugins:
  - search

The following options are supported:

lang

:octicons-milestone-24: Default: automatically set · This option allows to include the language-specific stemmers provided by lunr-languages. Note that Material for MkDocs will set this automatically based on the site language, but it may be overriden, e.g. to support multiple languages:

=== "A single language"

``` yaml
plugins:
  - search:
      lang: ru
```

=== "Multiple languages"

``` yaml
plugins:
  - search:
      lang:
        - en
        - ru
```

The following languages are supported:

• ar / Arabic
• da / Danish
• du / Dutch
• en / English
• fi / Finnish
• fr / French
• de / German
• hu / Hungarian
• it / Italian
• ja / Japanese
• no / Norwegian
• pt / Portuguese
• ro / Romanian
• ru / Russian
• es / Spanish
• sv / Swedish
• th / Thai
• tr / Turkish
• vi / Vietnamese

Material for MkDocs also tries to support languages which are not part of this list, by automatically chosing the best-matching stemmer.

!!! warning "Only specify the languages you really need"

Be aware that including support for other languages increases the general
JavaScript payload by around 20kb (before `gzip`) and by another 15-30kb
per language.

separator

:octicons-milestone-24: Default: automatically set – The separator for indexing and query tokenization can be customized, which makes it possible to index parts of words that are separated by other characters than whitespace and -, e.g. by including .:

plugins:
  - search:
      separator: '[\s\-\.]+'

prebuild_index

:octicons-milestone-24: Default: false · :octicons-beaker-24: Experimental – MkDocs can generate a prebuilt index of all pages during build time, which provides performance improvements at the cost of more bandwidth, as it reduces the build time of the search index:

plugins:
  - search:
      prebuild_index: true

This may be beneficial for large documentation projects served with appropriate headers, i.e. Content-Encoding: gzip, but benchmarking before deployment is recommended.

Material for MkDocs doesn't provide official support for the other options of this plugin, so they may be supported but can also yield weird results. Use them at your own risk.

Offline search

:octicons-file-code-24: Source · :octicons-cpu-24: Plugin · :octicons-beaker-24: Experimental

If you distribute your documentation as *.html files, the built-in search will not work out-of-the-box due to the restrictions modern browsers impose for security reasons. This can be mitigated with the localsearch plugin in combination with @squidfunk's iframe-worker polyfill.

For setup instructions, refer to the official documentation.

Customization

The search implementation of Material for MkDocs is probably its most sophisticated feature, as it tries to balance a great typeahead experience, good performance, accessibility and a result list that is easy to scan. This is where it deviates from other themes.

This section explains how search can be customized to tailor it to your needs.

Query transformation

:octicons-file-code-24: Source · :octicons-mortar-board-24: Difficulty: easy

When a user enters a query into the search box, the query is pre-processed before it is submitted to the search index. Material for MkDocs will apply the following transformations, which can be customized by extending the theme:

/**
 * Default transformation function
 *
 * 1. Search for terms in quotation marks and prepend a `+` modifier to denote
 *    that the resulting document must contain all terms, converting the query
 *    to an `AND` query (as opposed to the default `OR` behavior). While users
 *    may expect terms enclosed in quotation marks to map to span queries, i.e.
 *    for which order is important, `lunr` doesn't support them, so the best
 *    we can do is to convert the terms to an `AND` query.
 *
 * 2. Replace control characters which are not located at the beginning of the
 *    query or preceded by white space, or are not followed by a non-whitespace
 *    character or are at the end of the query string. Furthermore, filter
 *    unmatched quotation marks.
 *
 * 3. Trim excess whitespace from left and right.
 *
 * 4. Append a wildcard to the end of every word to make every word a prefix
 *    query in order to provide a good typeahead experience, by adding an
 *    asterisk (wildcard) in between terms, which can be denoted by whitespace,
 *    any non-control character, or a word boundary.
 *
 * @param value - Query value
 *
 * @return Transformed query value
 */
function defaultTransform(value: string): string {
  return value
    .split(/"([^"]+)"/g)                            /* => 1 */
      .map((terms, i) => i & 1
        ? terms.replace(/^\b|^(?![^\x00-\x7F]|$)|\s+/g, " +")
        : terms
      )
      .join("")
    .replace(/"|(?:^|\s+)[*+\-:^~]+(?=\s+|$)/g, "") /* => 2 */
    .trim()                                         /* => 3 */
    .replace(/\s+|(?![^\x00-\x7F]|^)$|\b$/g, "* ")  /* => 4 */
}

If you want to switch to the default behavior of the mkdocs or readthedocs template, both of which don't transform the query prior to submission, or customize the transform function, you can do this by overriding the config block:

{% block config %}
  <script>
    var search = {
      transform: function(query) {
        return query
      }
    }
  </script>
{% endblock %}

The transform function will receive the query string as entered by the user and must return the processed query string to be submitted to the search index.

Worker implementation

:octicons-file-code-24: Source · :octicons-mortar-board-24: Difficulty: challenging

Material for MkDocs implements search as part of a web worker. If you want to switch the web worker with your own implementation, e.g. to submit search to an external service, you can add a custom JavaScript file to the docs directory and override the config block:

{% block config %}
  <script>
    var search = {
      worker: "<url>"
    }
  </script>
{% endblock %}

Communication with the search worker is implemented using a standardized message format using discriminated unions, i.e. through the type property of the message. See the following interface definitions to learn about the message formats:

• :octicons-file-code-24: SearchMessage
• :octicons-file-code-24: SearchIndex and SearchResult

The sequence and direction of messages is rather intuitive:

• :octicons-arrow-right-24: SearchSetupMessage

• :octicons-arrow-left-24: SearchReadyMessage

• :octicons-arrow-right-24: SearchQueryMessage

• :octicons-arrow-left-24: SearchResultMessage