README

这是一个用于静态页面的客户端搜索引擎。

它使用预编译的搜索索引，为静态HTML页面添加全文搜索，例如 github pages 或离线API文档。索引是通过PHP脚本构建的，其方法与流行的搜索引擎 Lucene 类似，但更简化且更高效。

要查看其外观，请查看演示。

安装

运行索引生成器需要PHP 5.6或更高版本。

建议通过 composer 进行安装，在您的 composer.json 文件的 require 部分添加以下内容

{ "require" : 
  {
  "keiro/php-js-search": "~1.0"
  }
}

或者运行 composer require "keiro/php-js-search"。

使用命令行工具

vendor/bin/generateindex <path-to-your-html-files>

这将生成一个 jssearch.index.js 文件，您需要在HTML头部中包含此文件。

这将生成数据文件夹中的 search-engine-index.php 文件。例如，生成PHP sqlite索引

vendor/bin/generateindex tests/ -l php -db

有关js实现的示例，请参阅 example.html。
有关php实现的示例，请参阅 example-php.html。请注意，phpsearch.php 文件作为端点。您可以自由地将它的逻辑集成到自己的框架中。