hugo/docs/content/en/tools/search.md
2023-02-23 07:52:04 +01:00

3.5 KiB

title linktitle description date publishdate categories keywords menu weight sections_weight aliases toc
Search for your Hugo Website Search See some of the open-source and commercial search options for your newly created Hugo website. 2017-02-01 2017-02-01
developer tools
search
tools
docs
parent weight
tools 60
60 60
true

A static website with a dynamic search function? Yes, Hugo provides an alternative to embeddable scripts from Google or other search engines for static websites. Hugo allows you to provide your visitors with a custom search function by indexing your content files directly.

  • GitHub Gist for Hugo Workflow. This gist contains a simple workflow to create a search index for your static website. It uses a simple Grunt script to index all your content files and lunr.js to serve the search results.

  • hugo-lunr. A simple way to add site search to your static Hugo site using lunr.js. Hugo-lunr will create an index file of any HTML and Markdown documents in your Hugo project.

  • hugo-lunr-zh. A bit like Hugo-lunr, but Hugo-lunr-zh can help you separate the Chinese keywords.

  • GitHub Gist for Fuse.js integration. This gist demonstrates how to leverage Hugo's existing build time processing to generate a searchable JSON index used by Fuse.js on the client-side. Although this gist uses Fuse.js for fuzzy matching, any client-side search tool capable of reading JSON indexes will work. Does not require npm, grunt or other build-time tools except Hugo!

  • hugo-search-index. A library containing Gulp tasks and a prebuilt browser script that implements search. Gulp generates a search index from project markdown files.

  • hugofastsearch. A usability and speed update to "GitHub Gist for Fuse.js integration" — global, keyboard-optimized search.

  • JS & Fuse.js tutorial A simple client-side search solution, using FuseJS (does not require jQuery).

  • Pagefind. A fully static search library that aims to perform well on large sites, while using as little of your users' bandwidth as possible.

  • Hugo Lyra. Hugo-Lyra is a JavaScript module to integrate Lyra into a Hugo website. It contains the server-side part to generate the index and the client-side library (optional) to bootstrap the search engine easily.

Commercial Search Services

  • Algolia's Search API makes it easy to deliver a great search experience in your apps and websites. Algolia Search provides hosted full-text, numerical, faceted, and geolocalized search.
  • Bonsai is a fully-managed hosted Elasticsearch service that is fast, reliable, and simple to set up. Easily ingest your docs from Hugo into Elasticsearch following this guide from the docs.
  • ExpertRec is a hosted search-as-a-service solution that is fast and scalable. Set-up and integration is extremely easy and takes only a few minutes. The search settings can be modified without coding using a dashboard.