cebe/js-search

A client side search engine for use on static pages.

js-search

This is a client side search engine for use on static pages., _(*1)

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., _(*2)

To see how it looks like, check out the demo., _(*3)

Installation

PHP 5.4 or higher is required to run the index generator., _(*4)

Installation is recommended to be done via composer by adding the following to the require section in your composer.json:, _(*5)

"cebe/js-search": "~0.9"

Alternatively run composer require "cebe/js-search"., _(*6)

Usage

TODO., _(*7)

See example.html for an implementation., _(*8)

Generate the index

Using the command line tool:, _(*9)

vendor/bin/jsindex <path-to-your-html-files>

This will generate a jssearch.index.js file that you have to include in the HTML header., _(*10)