algoliasearch.zendesk-hc

Algolia Search for Zendesk

This JavaScript library allows you to replace the default search of your Zendesk Help Center by Algolia. Algolia is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.

Table of Content

1. Setup
2. Demo
3. License
4. Contributing

Setup

To be able to setup your new search on your Zendesk Help Center you'll need to have an Algolia account with a configured Zendesk Help Center crawler.

Extracting your data to Algolia

This crawler feature is still in beta, just send us an email to be part of the program!

• An Algolia account (our Hacker/FREE plan probably fits your need)
• A Zendesk API token (generate it following those steps)
• The associated Zendesk application name & email

Updating your Help Center theme

Once your data has been extracted to Algolia, you need to update your Help Center theme in order to replace the search feature by Algolia.

• Click "Customize the design"
• Select the "Document Head" template and add the following lines:

<link rel="stylesheet" type="text/css" href="//cdn.jsdelivr/algoliasearch-zendesk/1/algoliasearch-zendesk.min.css">
<script type="text/javascript" src="//cdn.jsdelivr/algoliasearch-zendesk/1/algoliasearch-zendesk.min.js"></script>
<script type="text/javascript">
  algoliasearchZendeskHC({
    application_id: '<YOUR APPLICATION_ID>',
    api_key: '<YOUR SEARCH ONLY API KEY>',
    sudomain: '<YOUR ZENDESK APPLICATION NAME>'
    //
    // Optional configuration:
    //
    // indexPrefix: 'zendesk_',    // or you custom <INDEX_PREFIX>
    // baseUrl: '/hc/',            // the base URL of your Help Center
    // colors: {
    //   primary: '#D4D4D4',       // the primary color
    //   secondary: '#D4D4D4'      // the secondary color
    // },
    // autocomplete: {
    //   enabled: true,            // is the autocomplete feature enabled?
    //   inputSelector: '#query',  // the DOM selector to select the search box
    //   sections: {
    //     enabled: true,          // does the autocomplete menu embed a 'sections' section
    //     hits: 3                 // the number of suggestions to display
    //   },
    //   articles: {
    //     enabled: true,          // does the autocomplete menu embed a 'articles' section
    //     hits: 3                 // the number of suggestions to display
    //   }
    // },
    // instantsearch: {
    //   enabled: true
    // }
  });
</script>

Demo

License

This library is MIT licensed.

Contributing

We're considering any contribution and PR, please go ahead!