cebe / js-search
A client side search engine for use on static pages.
Installs: 632 385
Dependents: 7
Suggesters: 0
Security: 0
Stars: 140
Watchers: 8
Forks: 25
Open Issues: 3
Requires
- php: >=5.4.0
This package is auto-updated.
Last update: 2024-12-05 19:24:11 UTC
README
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.
Installation
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 require section in your composer.json:
"cebe/js-search": "~0.9"
Alternatively run composer require "cebe/js-search".
Usage
TODO.
See example.html for an implementation.
Generate the index
Using the command line tool:
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.