PHPackages                             cebe/js-search - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Search & Filtering](/categories/search)
4. /
5. cebe/js-search

ActiveLibrary[Search & Filtering](/categories/search)

cebe/js-search
==============

A client side search engine for use on static pages.

0.9.3(9y ago)142702.7k↓34.1%25[2 issues](https://github.com/cebe/js-search/issues)[1 PRs](https://github.com/cebe/js-search/pulls)7MITPHPPHP >=5.4.0

Since Apr 25Pushed 8y ago5 watchersCompare

[ Source](https://github.com/cebe/js-search)[ Packagist](https://packagist.org/packages/cebe/js-search)[ RSS](/packages/cebe-js-search/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (4)DependenciesVersions (5)Used By (7)

js-search
=========

[](#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](https://pages.github.com/) 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](http://lucene.apache.org/).

To see how it looks like, check out the [demo](http://cebe.github.io/js-search/#demo).

Installation
------------

[](#installation)

PHP 5.4 or higher is required to run the index generator.

Installation is recommended to be done via [composer](https://getcomposer.org/) 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
-----

[](#usage)

TODO.

See [example.html](example.html) for an implementation.

### Generate the index

[](#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.

###  Health Score

40

—

FairBetter than 86% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity53

Moderate usage in the ecosystem

Community25

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 89.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~314 days

Total

4

Last Release

3510d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe)

---

Top Contributors

[![cebe](https://avatars.githubusercontent.com/u/189796?v=4)](https://github.com/cebe "cebe (17 commits)")[![bigmacfoobar](https://avatars.githubusercontent.com/u/6537154?v=4)](https://github.com/bigmacfoobar "bigmacfoobar (1 commits)")[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (1 commits)")

### Embed Badge

![Health badge](/badges/cebe-js-search/health.svg)

```
[![Health](https://phpackages.com/badges/cebe-js-search/health.svg)](https://phpackages.com/packages/cebe-js-search)
```

###  Alternatives

[awesome-nova/dependent-filter

Dependent filters for Laravel Nova

26193.1k](/packages/awesome-nova-dependent-filter)[algolia/php-dom-parser

A simple tool to turn DOM into Algolia search friendly record objects.

181.8k](/packages/algolia-php-dom-parser)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)