StaticSearch

StaticSearch is a simple search engine you can add to any static website. It uses client-side JavaScript and JSON data files so there's no need for back-end server technologies or databases.

StaticSearch works with Publican sites but you can use it on any static site built by any generator. It works best on English sites, but supports most Latin-based languages.

Full documentation is available at staticsearch.com

View the CHANGELOG for updates

To use StaticSearch, build your static site to a directory, then:

1. Index the pages to create JavaScript and JSON data files (do this every time your site changes).

2. Add search functionality to your site following the first index.

Index your site

Assuming you've generated your static site to a sub-directory named ./build/, run the StaticSearch CLI command:

npx staticsearch

StaticSearch creates a new directory named ./build/search/ containing JavaScript code and word index data.

If your site is in a different directory, such as ./dist/, use:

npx staticsearch --builddir ./dist/

For help, refer to StaticSearch indexer or view CLI configuration help:

npx staticsearch --help

environment variable configuration help:

npx staticsearch --helpenv

or Node.js API configuration help:

npx staticsearch --helpapi

Add search functionality to your site

StaticSearch provides a web component to enable search facilities. Add the following snippet to your static site template, perhaps in the HTML <header>:

<script type="module" src="/search/staticsearch-component.js"></script>

<static-search title="press Ctrl+K to search">
  <p>search</p>
</static-search>

Use any HTML element inside <static-search> to activate search when it's clicked. You can now rebuild your site to include the update and re-run the indexer to ensure word indexes are up-to-date.

For full help, refer to:

• StaticSearch web component: provides full search functionality

• StaticSearch bind module: attach search functionality to HTML <input> and result elements

• StaticSearch JavaScript search API: create your own custom search functionality.