cebe/js-search

用于静态页面的客户端搜索引擎。

维护者

详细信息

github.com/cebe/js-search

源代码

问题

安装次数: 617,816

依赖者: 7

建议者: 0

安全性: 0

星星: 140

关注者: 8

分支: 25

开放问题: 3

0.9.3 2016-11-22 12:11 UTC

Requires

  • php: >=5.4.0

MIT 3756a8b3387f3f7e5c778b964ec681dcf110b098

  • Carsten Brandt <mail.woop@cebe.cc>

This package is auto-updated.

Last update: 2024-09-05 18:39:32 UTC

README

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

它使用预编译的搜索索引，向静态HTML页面（如GitHub Pages或离线API文档）添加全文搜索。该索引由PHP脚本构建，其方法类似于流行的搜索引擎Lucene，但更简化且更易于导出。

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

安装

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

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

"cebe/js-search": "~0.9"

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

使用方法

待办事项。

查看example.html以获取实现示例。

生成索引

使用命令行工具

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

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