Get support for cebe/js-search

If you're new to LTH, please see our FAQ for more information on what it is we do.

Support Options

Unfortunately, there are currently no active helpers for this repository on the platform. Until they become available, we reccomend the following actions:

View Open Issues

Take a look to see if anyone else has experienced the same issue as you and if they managed to solve it.

Open an Issue

Make sure to read any relevant guidelines for opening issues on this repo before posting a new issue.

Sponsor directly

Check out the page and see if there are any options to sponsor this project or it's developers directly.

cebe/js-search

View on github

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.

Our Mission

We want to make open source more sustainable. The entire platform was born from this and everything we do is in aid of this.

From the Blog
Interesting Articles
Company

Thank you for checking out LiveTechHelper |
2025 © lth-dev incorporated

p-e622a1a2