Search

Displays a search form

Frontmatter

blocks:
  - type: search
    heading: {} # (optional)
      surtitle: '' # string (optional)
      title: '' # string (optional)
      text: '' # markdown (optional)
    ui: {} # (optional)
      theme: '' # [accent, black, dark, highlight, light, neutral, white] (optional)
      grid: '' # [xsmall, small, medium, large, container, full] (optional)
      offset: '' # [start, center, end] (optional)
      align: '' # [start, center, end] (optional)

The search is powered by Pagefind, which indexes the site after the build. The block renders nothing unless params.search.enable is on.

See Common keys for heading, footing and the full ui reference.

Params

/config/_default/params.yaml

params:
  search:
    enable: true # boolean, required for the block to render
    showEmptyFilters: true # boolean (optional)
    showImages: true # boolean (optional)
    showSubResults: true # boolean (optional)
Demo visual renderer

Files

CMS availability

CMSHugolify Admin v2
CloudCannonAvailable
Decap CMSAvailable
Netlify CMSAvailable
Pages CMSAvailable
Static CMSAvailable
Sveltia CMSAvailable
Tina CMSAvailable