js-search

by cebe

cebe /js-search

A client side search engine for use on static pages.

132 Stars 26 Forks Last release: almost 4 years ago (0.9.3) MIT License 19 Commits 4 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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 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 

This will generate a

jssearch.index.js
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.