https://github.com/algolia/algoliasearch-zendesk

Integrate Algolia within your Zendesk Help Center in minutes.
https://github.com/algolia/algoliasearch-zendesk

Last synced: 13 days ago
JSON representation

Integrate Algolia within your Zendesk Help Center in minutes.

• Host: GitHub
• URL: https://github.com/algolia/algoliasearch-zendesk
• Owner: algolia
• License: other
• Created: 2015-03-03T08:58:55.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-07-11T13:06:41.000Z (4 months ago)
• Last Synced: 2024-10-28T22:48:54.429Z (23 days ago)
• Language: JavaScript
• Homepage: https://community.algolia.com/zendesk
• Size: 10.3 MB
• Stars: 21
• Watchers: 81
• Forks: 12
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



This repository holds the code of Algolia's Zendesk integration.  

This integration makes it trivial to replace the default search of your Zendesk Help Center by Algolia.

[Algolia](https://www.algolia.com) is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.

We'll crawl your Zendesk API to extract your Help Center content and provide you a small code snippet to power your search with Algolia.

## Indexing

Find the code of the crawler and its documentation in the [crawler/](./crawler/) folder.

## Front-end

Follow the documentation [on the website](https://community.algolia.com/zendesk/documentation/).  

If you want to contribute or browse the code, follow [this link to the app/](./app/) folder.

## Development

The `package.json` in this repository holds 3 scripts:

- `npm run release:docs`: Release the documentation site on https://community.algolia.com/zendesk/

- `npm run release:app`: Release the JS library on `npm`

- `npm run release`: Runs the previous scripts and `git push`

## ChangeLog

See the [CHANGELOG.md](./CHANGELOG.md) file.

## License

This project is under the [MIT License](./LICENSE).