Need help with js-search?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

139 Stars 25 Forks MIT License 19 Commits 3 Opened issues


A client side search engine for use on static pages.

Services available


Need anything else?

Contributors list


This is a client side search engine for use on static pages.

It uses a pre-compiled search index to add a fulltext search to static HTML pages such as github pages or offline API documentation. The index is built by a PHP script using a similar yet much more simplified and dump approach than the popular search engine Lucene.

To see how it looks like, check out the demo.


PHP 5.4 or higher is required to run the index generator.

Installation is recommended to be done via composer by adding the following to the

section in your
"cebe/js-search": "~0.9"

Alternatively run

composer require "cebe/js-search"



See example.html for an implementation.

Generate the index

Using the command line tool:


This will generate a

file that you have to include in the HTML header.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.