Skip to content
Invisible link to canonical for Microformats Enable Fuse.js search

Enable Fuse.js search

Add a search page to an existing site

Use this guide for an existing site where you want Fuse.js search. The Chulapa 101 template already has it configured; check its existing search page before adding another. No provider account, API key or extra Jekyll plugin is needed for Fuse.js.

Configure the search page

  1. In _config.yml, edit the existing search section, or add it once if absent:

    search:
  provider: fusejs
  landing_page: /search

    Keep any other search settings. If your current search has an established address, use that path for landing_page and for the page below.

  2. Find your existing search page and edit it. If there is none, create search.md at the site root, alongside _config.yml, with this complete content:

    ---
layout: search
title: Search
permalink: /search
---

    Keep only one page at this output address. The page’s permalink must match search.landing_page. For a site under /my-blog, use /search in both settings; the theme adds the site’s baseurl.

  3. Save your changes on the publishing branch. Wait for Actions to finish, then open the search address directly. For a site at https://ana.github.io/my-blog, open https://ana.github.io/my-blog/search (or your chosen landing path).

Selecting a provider does not create the search page. The classic navbar and the desktop form of dual show a Search link only when navbar.nav is configured. If that link is absent, use the direct address above or configure your menu. The search layout supplies its own interface; extra page-body text is not displayed.

Check a result

Search for a distinctive word from a published article’s title. Follow the result and check that it opens the correct article, including on a repository-based site. Clear the search field and check that the results clear.

If the search page is missing, check its published address and the two matching settings above. If a document is absent from results, check its date, publishing status and any include_on_search: false in its front matter or defaults. Content changes enter the search index during the next site build; republish after edits.

To switch providers, use Lunr.js, Simple-Jekyll-Search, Google Custom Search or Algolia. For exact field defaults, use the search reference. For a working interface, see the Fuse.js demo.

In 2.2.1 (development), Fuse.js is updated to 7.5.0. Its corrected relevance scores can change result ordering and the number of results shown. The standard search layout handles the update automatically. If you copied a Fuse.js search page or adapter into your site, update it from the current demo source and adapter: the adapter must load with type="module" and imports Fuse.js itself. Remove the old separate fuse.min.js script tag. Serve the page through Jekyll or your published site; opening the HTML directly with file:// does not support this module loading.

Related documentation