This repository has been archived by the owner on May 9, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 114
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(woocommerce): add WooCommerce dedicated page
- Loading branch information
Showing
8 changed files
with
102 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
--- | ||
title: WooCommerce integration with Algolia Search | ||
description: Getting started with the Algolia plugin for WooCommerce. | ||
layout: page.html | ||
--- | ||
|
||
## Introduction | ||
|
||
**The Algolia plugin for WooCommerce is provided as is and may require some developer workforce in order to get it integrated & adapted to your store. No support specific for WooCommerce will be delivered.** | ||
|
||
[WooCommerce](https://wordpress.org/plugins/woocommerce/) is the most famous plugin for turning your WordPress into a store. | ||
|
||
## Requirements | ||
|
||
Algolia Search plugin for WooCommerce has a few system requirements to be able to work properly. | ||
|
||
You will need to make sure your server meets the following requirements: | ||
|
||
- WordPress 4.4+ | ||
- [WooCommerce plugin](https://wordpress.org/plugins/woocommerce/) 3.0+ | ||
- [Algolia plugin for WordPress](https://wordpress.org/plugins/search-by-algolia-instant-relevant-results/) 1.6+ | ||
- PHP 5.6 or greater | ||
- MySQL 5.6 or greater | ||
- cURL PHP extension | ||
- mbstring PHP extension | ||
|
||
## Installation | ||
|
||
For the Algolia plugin for WooCommerce to work you will need have the following plugins installed: | ||
|
||
- Algolia search: https://wordpress.org/plugins/search-by-algolia-instant-relevant-results/ | ||
- WooCommerce: https://wordpress.org/plugins/woocommerce/ | ||
|
||
Once that is the case, you can install the Algolia plugin for WooCommerce that you can clone from: https://github.com/algolia/algoliasearch-woocommerce | ||
|
||
If you need further help with the installation process, please give the [installation guide](https://wordpress.org/plugins/search-by-algolia-instant-relevant-results/installation/) a try. | ||
|
||
## Create an Algolia account | ||
|
||
If you haven't got an Algolia account, now is a good time to create one by subscribing [here](https://www.algolia.com/users/sign_up). | ||
|
||
<div class="alert alert-info">You don't need to push your data as suggested in the onboarding tutorial as this plugin will handle it for you.</div> | ||
|
||
## Fill in your Algolia credentials | ||
|
||
Now that your Algolia account is created, head to the `API keys` page: | ||
|
||
![API keys](img/quick-start/api-keys.png) | ||
|
||
In your WordPress admin panel, head to the Algolia Search link in the left sidebar: | ||
|
||
![Algolia search menu entry](img/quick-start/algolia-search-menu-entry.png) | ||
|
||
Copy the API keys from the Algolia website to your website instance and hit the <span class="wp-btn">Save changes</span> button. | ||
|
||
## Index products | ||
|
||
The Algolia Search menu in the left sidebar should now be expanded: | ||
|
||
![Algolia search expanded menu](img/quick-start/expanded-menu.png) | ||
|
||
Head to the indexing page, check the `Products [posts_product]` index and hit the <span class="wp-btn">Save changes</span>. | ||
|
||
This will trigger the indexing of the products. While this is taking place you can continue the configuration of the plugin because indexing is done in the background. | ||
|
||
## Choose on what pages to display the instant search experience | ||
|
||
Head to the WooCommerce menu entry of the Algolia Search plugin: | ||
|
||
![Algolia search expanded menu](img/quick-start/pages-screen.png) | ||
|
||
|
||
Choose on what page types you want to inject the search on and hit the <span class="wp-btn">Save changes</span>. | ||
|
||
## Choose where to inject your search inside of the pages | ||
|
||
The plugin requires a CSS selector to be able to determine where to inject the search inside of the pages. | ||
|
||
To make this process as simple as possible, on the `Zoning` page we load the first category of your website so that you simply have to click on the area where you'd like to see the search injected. | ||
|
||
<div class="alert alert-info">Please note that sometimes you will need to manually adjust the detected selector depending on how your theme's HTML is structured.</div> | ||
|
||
Once you chose your selector, you can hit the <span class="wp-btn">Save changes</span>. | ||
|
||
<div class="alert alert-info">You'll get a notification in the frontend if the selector you configured does not match any element. This notification only displays if you are the admin.</div> | ||
|
||
## Customize the appearance | ||
|
||
Finally head to the `Appearance` tab: | ||
|
||
![Appearance screen](img/quick-start/appearance-screen.png) | ||
|
||
Select a color that matches your theme and hit the <span class="wp-btn">Save changes</span>. | ||
|
||
This will automatically change the color of all search UI components on your website: | ||
|
||
![Search UI](img/quick-start/search-ui.png) | ||
|
||
|
||
|
||
|