To browse through the crawler, visit the crawler/ folder.
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.
Synchronize Algolia with your Help Center data
- Login or sign-up on Algolia
- Visit our Zendesk community page and click
Join the beta
- Enter your zendesk subdomain (
- When Zendesk asks you to approve Algolia in your Zendesk instance, click
- That's it! Algolia now automatically handles the indexing of your Help Center
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.
- Copy the code displayed on the connector page in your Algolia account
- Go to your Zendesk Help Center
- Click "General" > "Customize the design" in the top bar
- In the "Theme" section, click on "Edit theme"
- In the top left corner dropdown, select the "Document Head" template
- Paste the lines you copied before at the end of the template
- Save and check if everything works
- If it does, you can now click "Publish Theme"
Handling Zendesk community search
We do not index community forums at the moment. If you're using them, you'll probably want to disable
instantsearch by setting
Customizing the CSS
If you want to change the CSS styling of the search we provide, there's absolutely no issue. To do this:
- You should have a look at the scss file to see all the rules we're using
- Add a
<style>tag after the
<link>tag you've already added in your Document Head template We ask you to do this because the CSS code in the customization panel is included before the Document Head template
/1/in the URLs by
/1.X.Y/. (Current version: ) Indeed, we might do some small CSS changes between minor versions.
In the end, you should have something along these lines in your Document Head template:
Supporting multiple languages
Out of the box, the library limits the results to the currently selected language.
However, some constant strings like the ones used in the sentence "12 results found in 1ms" need to be translated in your language. In order to do so, you need to use the
translations parameter described in the documentation above.
If you're using only one language in your Help Center, just pass the strings of this specific language. For example, for French, you might want to pass:
translations:article: 'Article'articles: 'Articles'categories: 'Catégories'found_in: 'Trouvés en'no_result: 'Aucun résultat'placeholder_autocomplete: 'Rechercher dans les articles et sections'placeholder_instantsearch: 'Rechercher dans les articles'result: 'Résultat'results: 'Résultats'search_by: 'Recherche par'sections: 'Sections'tags: 'Tags'
If you want to support multiple languages though, you'll need to pass for each key an object using locales as key. The locale is
yoursupport.zendesk.com/hc/en-us. For example, for English and French, you might want to pass:
translations:article:'en-us': 'Article''fr': 'Article'articles:'en-us': 'Articles''fr': 'Articles'categories:'en-us': 'Categories''fr': 'Catégories'found_in:'en-us': 'Found in''fr': 'Trouvés en'no_result:'en-us': 'No result''fr': 'Aucun résultat'placeholder_autocomplete:'en-us': 'Search in articles and sections''fr': 'Rechercher dans les articles et sections'placeholder_instantsearch:'en-us': 'Search in articles''fr': 'Rechercher dans les articles'result:'en-us': 'Result''fr': 'Résultat'results:'en-us': 'Results''fr': 'Résultats'search_by:'en-us': 'Search by''fr': 'Recherche par'sections:'en-us': 'Sections''fr': 'Sections'tags:'en-us': 'Tags''fr': 'Tags'
package.json holds multiple scripts:
build:css: Compiles the CSS files to
build:docs: Extracts the documentation from this
build:js: Compiles the JS files to
build: Launches all 3 previous builds
server, and watches the files to rebuild them if needed
lint: Lints the JS files
server: Runs a simple HTTP server pointing to
testwith coverage enabled
test: Runs the test suite
dev can be passed a
NODE_ENV environment variable.
If set to production, it also creates minified files and map files.
server accepts a
PORT environment variable to change on which port it will run.
We're considering any contribution and PR, please go ahead!
This project is under the MIT License.