bent10 / boox

Search anything, instantly

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.
cli	CLI tool to train your datasets with Boox.

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:

• Vanilla JavaScript
• React
• Vue.js
• Svelte
• Angular
• Next.js
• Express.js

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

A project by Stilearning © 2024.

boox's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency sass to v1.77.3

Detected dependencies

github-actions

.github/workflows/pr-title.yml

• actions/checkout v4
• amannn/action-semantic-pull-request v5

.github/workflows/release.yml

• actions/checkout v4
• actions/setup-node v4

.github/workflows/validate.yml

• actions/checkout v4
• actions/setup-node v4

npm

package.json

• batch-me-up ^1.0.0
• doogu ^3.2.13
• vite-plugin-cachedir ^1.2.0
• vite-plugin-resolve-umd-format ^1.0.0

packages/cli/package.json

• commander ^12.0.0
• ora ^8.0.1
• pako ^2.1.0
• rcfy ^2.1.0
• @types/pako ^2.0.3

packages/core/package.json

packages/site/package.json

• @popperjs/core ^2.11.8
• bootstrap ^5.3.3
• clipboard ^2.0.11
• @headless-route/vite ^1.3.5
• @testing-library/jest-dom ^6.4.5
• @types/bootstrap ^5.2.10
• @types/moo ^0.5.9
• @types/stopword ^2.0.3
• autoprefixer ^10.4.19
• double-metaphone ^2.0.1
• fastest-levenshtein ^1.0.16
• github-slugger ^2.0.0
• marked ^12.0.2
• marked-alert ^2.0.1
• marked-directive ^1.0.5
• marked-plaintify ^1.0.1
• marked-shiki ^1.1.0
• metaphone ^2.0.1
• moo ^0.5.2
• posthtml ^0.16.6
• posthtml-bootstrap ^1.0.3
• posthtml-component ^1.1.1
• posthtml-extend ^0.6.5
• sass ^1.76.0
• shiki ^1.4.0
• stemmer ^2.0.1
• stophtml ^1.0.2
• stopword ^3.0.1
• vite-plugin-purge ^1.0.3

---

• Check this box to trigger a request for Renovate to run again on this repository