Эта база кода, разработанная Джоуи Такедой и Мартином Холмсом, предоставляет настраиваемый, настраиваемый инструмент, с помощью которого вы можете указать на коллекцию документов XHTML5 и создать страницу поиска, не требующую серверного компонента. Он создает структурированные индексы всего текста документа, а также страницу поиска HTML, включающую функции фасетного поиска на основе тегов <meta>
в коллекции документов. Страница поиска использует чистый JavaScript для запроса индекса, который представляет собой большую коллекцию небольших файлов JSON, чтобы обеспечить быстрый и сложный поиск для любого веб-сайта малого и среднего размера. Поиск вообще не требует какого-либо серверного кода.
Код генерации использует XSLT3, а функция поиска — JavaScript. Реализация стеммера Porter2 в XSLT и JavaScript является частью пакета. Страницы живого поиска, основанные на этом коде, уже используются на сайтах Mapping Keats's Progress , The Map of Early Modern London и The Winnifred Eaton Archive .
Веткой этого репозитория по умолчанию является ветка разработки; основная ветка используется для релизов. Официальные выпуски начались в начале 2020 года, и основная ветка всегда будет отражать последний тег выпуска, поэтому вы можете прикрепить свой собственный проект либо к мастеру, либо к определенному тегу выпуска, чтобы избежать неожиданных изменений в поведении из-за изменений в кодовой базе. Для тестирования и подготовки к предстоящим изменениям вы можете использовать ветку dev. Релизы также архивируются на Zenodo:
Полную документацию можно найти в файле docs/staticSearch.html. Документацию с возможностью поиска в реальном времени (созданную с использованием staticSearch) для последней версии можно найти на сайте Project Endings.
Пожалуйста, сообщайте обо всех проблемах, с которыми вы сталкиваетесь, в виде заявок в репо.
Код лицензируется как MPL, так и BSD.