Configurations

September 25, 2023 4 min read Search Modules Parameters

List of available site parameters and page parameters for the Hugo search module.

Donate

Become a backer or sponsor to support our work.

Site Parameters

hugo.yaml

1params:
2  search:
3    stall_threshold: 200

hugo.toml

1[params]
2  [params.search]
3    stall_threshold = 200

hugo.json

1{
2   "params": {
3      "search": {
4         "stall_threshold": 200
5      }
6   }
7}

`case_sensitive`

Indicates whether comparisons should be case sensitive.

Name	Type	Default	Required
`case_sensitive`	`boolean`	`false`	-

`distance`

Determines how close the match must be to the fuzzy location (specified by location). An exact letter match which is distance characters away from the fuzzy location would score as a complete mismatch. A distance of 0 requires the match be at the exact location specified. A distance of 1000 would require a perfect match to be within 800 characters of the location to be found using a threshold of 0.8.

Name	Type	Default	Required
`distance`	`number`	`100`	-

`expand_results_meta`

When true, expand the results meta by default.

Name	Type	Default	Required
`expand_results_meta`	`boolean`	`false`	-

`filter_taxonomies`

Whether to enable the taxonomies filter, see also index_taxonomies.

Name	Type	Default	Required
`filter_taxonomies`	`boolean`	`true`	-

`filter_years`

Whether to enable the years filter.

Name	Type	Default	Required
`filter_years`	`boolean`	`true`	-

`headings_end_level`

The end level of headings.

Name	Type	Default	Required
`headings_end_level`	`number`	`6`	-

`ignore_location`

When true, search will ignore location and distance, so it won't matter where in the string the pattern appears.

Name	Type	Default	Required
`ignore_location`	`boolean`	`false`	-

`index_all_pages`

When true, all pages except noindex pages will be indexed, include non-regular pages, such as home and taxonomy lists.

Name	Type	Default	Required
`index_all_pages`	`boolean`	`false`	-

`index_content`

When true, the engine will also search by content, you may need to tweak the distance parameter as well. Please note that, it may become a performance killer on a large site.

Name	Type	Default	Required
`index_content`	`boolean`	`false`	-

`index_headings`

Whether to index the headings, see also the headings_end_level parameter.

Name	Type	Default	Required
`index_headings`	`boolean`	`true`	-

`index_summary`

Whether to index the summary.

Name	Type	Default	Required
`index_summary`	`boolean`	`true`	-

`index_taxonomies`

Whether to index the taxonomies, if false, the filter_taxonomies will be automatically disabled as well.

Name	Type	Default	Required
`index_taxonomies`	`boolean`	`true`	-

`key_weights`

The weights of keys, see also https://www.fusejs.io/examples.html#default-weight.

Name	Type	Default	Required
`key_weights`	`object`	-	-

`key_weights.content`

The weight of content.

Name	Type	Default	Required
`key_weights.content`	`number`	`0.5`	-

`key_weights.headings`

The weight of headings.

Name	Type	Default	Required
`key_weights.headings`	`number`	`0.5`	-

`key_weights.lang`

The weight of language.

Name	Type	Default	Required
`key_weights.lang`	`number`	`1`	-

`key_weights.summary`

The weight of summary.

Name	Type	Default	Required
`key_weights.summary`	`number`	`1`	-

`key_weights.taxonomies`

The weight of taxonomies.

Name	Type	Default	Required
`key_weights.taxonomies`	`number`	`0.1`	-

`key_weights.title`

The weight of title.

Name	Type	Default	Required
`key_weights.title`	`number`	`1`	-

`key_weights.year`

The weight of year.

Name	Type	Default	Required
`key_weights.year`	`number`	`1`	-

`lazy_loading`

Lazy loading the indices.

Name	Type	Default	Required
`lazy_loading`	`boolean`	`true`	-

`location`

Determines approximately where in the text is the pattern expected to be found.

Name	Type	Default	Required
`location`	`number`	`0`	-

`max_results`

Denotes the max number of returned search results.

Name	Type	Default	Required
`max_results`	`number`	`100`	-

`min_match_char_length`

Only the matches whose length exceeds this value will be returned. (For instance, if you want to ignore single character matches in the result, set it to 2).

Name	Type	Default	Required
`min_match_char_length`	`number`	`1`	-

`modal_container`

The container for the search modal. It should be a valid CSS selector. Leave it empty if you're using single search page mode only.

Name	Type	Default	Required
`modal_container`	`string`	`body`	-

`modal_toggle_selector`

The search modal toggle selector.

Name	Type	Default	Required
`modal_toggle_selector`	`string`	`.search-modal-toggle`	-

`paginate`

How many results per page, at least 20, for making sure the load more event will be able to trigger.

Name	Type	Default	Required
`paginate`	`number`	`20`	-

`shortcut_close`

Shortcuts to close the search modal. Empty array means disabled. See key values for keyboard events.

Name	Type	Default	Required
`shortcut_close`	`array`	`[Escape]`	-

`shortcut_search`

Shortcuts to open the search modal. Leave it empty to disable.

Name	Type	Default	Required
`shortcut_search`	`array`	`[Control k]`	-

`stall_threshold`

How many milliseconds must elapse before considering the autocomplete experience stalled.

Name	Type	Default	Required
`stall_threshold`	`number`	`300`	-

`threshold`

At what point does the match algorithm give up. A threshold of 0.0 requires a perfect match (of both letters and location), a threshold of 1.0 would match anything.

Name	Type	Default	Required
`threshold`	`number`	`0.6`	-

Page Parameters

AKA front matter.

`noindex`

When true, the page won't be indexed, that is, it won't appear on the search results.

Name	Type	Default	Required
`noindex`	`boolean`	`false`	-

Single Page Mode

CSS Variables

Browse Search

Configurations

Site Parameters

case_sensitive

distance

expand_results_meta

filter_taxonomies

filter_years

headings_end_level

ignore_location

index_all_pages

index_content

index_headings

index_summary

index_taxonomies

key_weights

key_weights.content

key_weights.headings

key_weights.lang

key_weights.summary

key_weights.taxonomies

key_weights.title

key_weights.year

lazy_loading

location

max_results

min_match_char_length

modal_container

modal_toggle_selector

paginate

shortcut_close

shortcut_search

stall_threshold

threshold