{"id":16314916,"url":"https://github.com/cebe/js-search","last_synced_at":"2025-04-05T17:09:16.520Z","repository":{"id":16351747,"uuid":"19101720","full_name":"cebe/js-search","owner":"cebe","description":"A client side search engine for use on static pages.","archived":false,"fork":false,"pushed_at":"2018-01-21T14:30:51.000Z","size":357,"stargazers_count":139,"open_issues_count":3,"forks_count":25,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-29T16:08:00.686Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://cebe.github.io/js-search/#demo","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cebe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-04-24T08:46:15.000Z","updated_at":"2025-03-15T20:59:02.000Z","dependencies_parsed_at":"2022-09-10T16:32:36.627Z","dependency_job_id":null,"html_url":"https://github.com/cebe/js-search","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cebe%2Fjs-search","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cebe%2Fjs-search/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cebe%2Fjs-search/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cebe%2Fjs-search/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cebe","download_url":"https://codeload.github.com/cebe/js-search/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247369953,"owners_count":20927928,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T21:55:36.486Z","updated_at":"2025-04-05T17:09:16.486Z","avatar_url":"https://github.com/cebe.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"js-search\n=========\n\nThis is a client side search engine for use on static pages.\n\nIt uses a pre-compiled search index to add a fulltext search to static HTML pages such as\n[github pages][] or offline API documentation. The index is built by a PHP script using a\nsimilar yet much more simplified and dump approach than the popular search engine [Lucene].\n\nTo see how it looks like, check out the [demo][].\n\n[github pages]: https://pages.github.com/\n[Lucene]: http://lucene.apache.org/\n[demo]: http://cebe.github.io/js-search/#demo\n\n\nInstallation\n------------\n\nPHP 5.4 or higher is required to run the index generator.\n\nInstallation is recommended to be done via [composer](https://getcomposer.org/) by adding the following to the `require` section in your `composer.json`:\n\n```json\n\"cebe/js-search\": \"~0.9\"\n```\n\nAlternatively run `composer require \"cebe/js-search\"`.\n\n\nUsage\n-----\n\nTODO.\n\nSee [example.html](example.html) for an implementation.\n\n### Generate the index\n\nUsing the command line tool:\n```\nvendor/bin/jsindex \u003cpath-to-your-html-files\u003e\n```\n\nThis will generate a `jssearch.index.js` file that you have to include in the HTML header.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcebe%2Fjs-search","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcebe%2Fjs-search","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcebe%2Fjs-search/lists"}