js-search

A client side search engine for use on static pages.

View the Project on GitHub cebe/js-search

js-search

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 enging Lucene.

See the README for installation and usage instructions.

Demo

This demo shows a search on an index built for the Yii framework 2.0 API docs and the definitive guide. This index in this demo was built independent from the yii docs so some links may be outdated.

The search is performed as you type, so enter something in the search field and enjoy. "Something" could be "Active Record", "REST API", "html" or anything else you may find interesting.


Results: