Skip to content

Commit eb465f2

Browse files
Merge #696 #701
696: Fix hyperlinks of the table of contents r=bidoubiwa a=bidoubiwa 701: Add link to explaination on how to set up refinementList r=bidoubiwa a=bidoubiwa Co-authored-by: Charlotte Vermandel <[email protected]> Co-authored-by: cvermand <[email protected]>
3 parents 2da557d + ec85ec1 + 0f62e22 commit eb465f2

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ NB: If you don't have any Meilisearch instance running and containing your data,
4646
- [📜 API Resources](#-api-resources)
4747
- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
4848

49-
## Installation
49+
## 🔧 Installation
5050

5151
Use `npm` or `yarn` to install `instant-meilisearch`:
5252

@@ -61,7 +61,7 @@ yarn add @meilisearch/instant-meilisearch
6161
`instant-meilisearch` is a client for `instantsearch.js`. It does not create any UI component by itself.<br>
6262
To be able to create a search interface, you'll need to [install `instantsearch.js`](https://www.algolia.com/doc/guides/building-search-ui/installation/js/) as well.
6363

64-
## Usage
64+
## 🎬 Usage
6565

6666
### Basic
6767

@@ -149,7 +149,7 @@ genres:
149149
{ keepZeroFacets : true } // default: false
150150
```
151151

152-
## Example with InstantSearch
152+
## ⚡️ Example with InstantSearch
153153

154154
The open-source [InstantSearch](https://www.algolia.com/doc/api-reference/widgets/js/) library powered by Algolia provides all the front-end tools you need to highly customize your search bar environment.
155155

@@ -239,7 +239,7 @@ This package only guarantees the compatibility with the [version v0.26.0 of Meil
239239
- NodeJS >= 12.10 <= 14
240240
- NPM >= 6.x
241241

242-
## API resources
242+
## 📜 API resources
243243

244244
List of all the components that are available in [instantSearch](https://github.com/algolia/instantsearch.js) and their compatibility with [Meilisearch](https://github.com/meilisearch/meilisearch/).
245245

@@ -657,6 +657,8 @@ instantsearch.widgets.refinementList({
657657
})
658658
```
659659

660+
⚠️ To make refinementList work, [please refer to this](#hierarchical-menu-usage).
661+
660662
### ✅ HierarchicalMenu
661663

662664
[Hierarchical menu references](https://www.algolia.com/doc/api-reference/widgets/hierarchical-menu/js/)
@@ -1042,7 +1044,7 @@ Virtual indices allow you to use Relevant sort, a sorting mechanism that favors
10421044
Routing is configured inside `instantSearch` component. Please refer [to the documentation](https://www.algolia.com/doc/api-reference/widgets/simple-state-mapping/js/) for further implementation information.
10431045

10441046

1045-
## Development Workflow and Contributing
1047+
## ⚙️ Development Workflow and Contributing
10461048

10471049
Any new contribution is more than welcome in this project!
10481050

0 commit comments

Comments
 (0)