staticsearch

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 but can be used on any static site built by any generator. It currently works best on English language sites, but most Western languages can be used.

Full documentation is available at publican.dev/staticsearch

View the CHANGELOG for updates

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

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

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

Index your site

Assuming your static site is generated in a sub-directory named ./build/, run the StaticSearch CLI command:

npx staticsearch

It 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 quickly add search facilities to your site. Add the following snippet to any 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>

Any HTML element can be placed inside <static-search> to activate search when it's clicked. You can now rebuild the site to include this update and re-run the indexer.

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: implement custom search functionality