/boox

Search anything, instantly

Primary LanguageTypeScriptMIT LicenseMIT

Boox

Boox is a lightweight, zero-dependency full-text search library designed for both browser and Node.js. It enables you to efficiently search through multiple documents and datasets, returning relevant results based on your queries.

Packages

Package Description Version (click for changelog)
core The Boox package. npm
cli CLI tool to train your datasets with Boox. npm

Documentation

Go to Boox documentation.

Integration

Boox is designed to be flexible and can be easily integrated with other libraries and frameworks to enhance your search functionality. The key is to manage the search state and update the UI based on the search results returned by Boox. Here are some examples of how you can integrate Boox with popular tools:

Contributing

We 💛  issues.

When committing, please conform to the semantic-release commit standards. Please install commitizen and the adapter globally, if you have not already.

npm i -g commitizen cz-conventional-changelog

Now you can use git cz or just cz instead of git commit when committing. You can also use git-cz, which is an alias for cz.

git add . && git cz

License

GitHub

A project by Stilearning © 2024.