Skip to content
forked from cebe/js-search

A client side search engine for use on static pages.

License

Notifications You must be signed in to change notification settings

nztim/js-search

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 <path-to-your-html-files>

This will generate a jssearch.index.js file that you have to include in the HTML header.

About

A client side search engine for use on static pages.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 71.7%
  • JavaScript 15.7%
  • HTML 12.2%
  • Batchfile 0.4%