# tpsearch **Work in Progress:** * Needs cleanup * Add minimal example * either update pelican plugin `tipue_search` or the output-function must return to a rudimentary one. JavaScript-based search engine for static websites tpsearch is a fork of Tipue Search, a JavaScript-based search engine. tpsearch allows searching over an array of pages or articles for search words. For example the static website generator pelican has a plugin (`tipue_search`), which emits a compatible JSON-object for use with tpsearch. At the moment, tpsearch assumes, that an object named `tipue_search` exists, which contains all the article-information (e.g. generated by the pelican plugin `tipue_search` or similar plugins). The object is assumed to be of this scheme (newlines are ignored): ```javascript var tipuesearch = { "pages": [ { "title": ... }, { ... }, ... ] } ``` ## Depedencies A decently recent JavaScript engine would do. No additional libraries are needed. ## Minimal Example A minimal working example will be added to the repository in the future. But here a very short set-up: You HTML will need the following: * include the JavaScript files * a search box * an area, where the search results are shown ```html