Algolia for Zendesk Guide
This JavaScript library replaces the default search of your Zendesk Guide help center by Algolia.
Algolia is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.
Documentation
Read our documentation on algolia.com.
Development
The package.json
holds multiple scripts:
clean
: Removes dist/
and node_modules/
build
: Compiles the JS & CSS files to dist/algoliasearch.zendesk-hc.{css,js}
dev
: Launches parcel
, and watches the files to rebuild them if neededlint
: Lints the JS filesformat
: Runs prettier
Contributing
We're considering any contribution and PR, please go ahead!
Release
Bump the version in package.json
. We follow semantic versioning.
npm install
npm run clean
NODE_ENV=production npm run build
npm publish
License
This project is under the MIT License.