You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<palign="center">⚡ The MeiliSearch plugin for VuePress</p>
23
+
<palign="center">⚡ The Meilisearch plugin for VuePress</p>
24
24
25
-
**MeiliSearch VuePress** is a **MeiliSearch** plugin for VuePress.
25
+
**Meilisearch VuePress** is a **Meilisearch** plugin for VuePress.
26
26
27
-
**MeiliSearch** is an open-source search engine. [Discover what MeiliSearch is!](https://github.com/meilisearch/MeiliSearch)
27
+
**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/Meilisearch)
28
28
29
29
If you don't use VuePress for your documentation, but you still need a search bar, you might check out this [front-end SDK](https://github.com/meilisearch/docs-searchbar.js).
This plugin is used in production on the [MeiliSearch documentation](https://docs.meilisearch.com/).
33
+
This plugin is used in production on the [Meilisearch documentation](https://docs.meilisearch.com/).
34
34
35
35
## Table of Contents <!-- omit in toc -->
36
36
@@ -39,15 +39,15 @@ This plugin is used in production on the [MeiliSearch documentation](https://doc
39
39
-[Installation](#installation)
40
40
-[Basic Configuration](#basic-configuration)
41
41
-[Customization](#customization)
42
-
-[Compatibility with MeiliSearch](#compatibility-with-meilisearch)
42
+
-[Compatibility with Meilisearch](#compatibility-with-meilisearch)
43
43
-[Development Workflow and Contributing](#development-workflow-and-contributing)
44
44
-[Related Repositories](#related-repositories)
45
45
46
46
## Usage
47
47
48
48
### Before using the plugin
49
49
50
-
The goal of this plugin is to provide very easy integration of a search bar into your own VuePress documentation. To make that possible, you need to gather your website content in advance, and index it in a MeiliSearch instance.
50
+
The goal of this plugin is to provide very easy integration of a search bar into your own VuePress documentation. To make that possible, you need to gather your website content in advance, and index it in a Meilisearch instance.
51
51
52
52
Luckily, we provide all the tools that you need, and can help you through the whole process, if you follow [this guide](https://docs.meilisearch.com/create/how_to/search_bar_for_docs.html) 🚀
53
53
@@ -61,8 +61,8 @@ yarn playground
61
61
62
62
Then, open your browser on the indicated URL and test the search bar 🙂
63
63
64
-
The data comes from MeiliSearch documentation.<br>
65
-
Type `create an indxe` to live the MeiliSearch experience with the [typo tolerance](https://docs.meilisearch.com/reference/under_the_hood/typotolerance.html).
64
+
The data comes from Meilisearch documentation.<br>
65
+
Type `create an indxe` to live the Meilisearch experience with the [typo tolerance](https://docs.meilisearch.com/reference/under_the_hood/typotolerance.html).
66
66
67
67
### Installation
68
68
@@ -93,8 +93,8 @@ module.exports = {
93
93
}
94
94
```
95
95
96
-
**WARNING**: Since the configuration file is public, we recommend providing the MeiliSearch public key, which is enough to perform searches.<br>
97
-
Read more about [MeiliSearch authentication](https://docs.meilisearch.com/reference/features/authentication.html#authentication).
96
+
**WARNING**: Since the configuration file is public, we recommend providing the Meilisearch public key, which is enough to perform searches.<br>
97
+
Read more about [Meilisearch authentication](https://docs.meilisearch.com/reference/features/authentication.html#authentication).
98
98
99
99
### Customization
100
100
@@ -137,9 +137,9 @@ $dropdownBgDarkColor
137
137
138
138
You can also find an example in our [playground's `palette.styl` file](./playground/.vuepress/styles/palette.styl)
139
139
140
-
## Compatibility with MeiliSearch
140
+
## Compatibility with Meilisearch
141
141
142
-
This package only guarantees the compatibility with the [version v0.24.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.24.0).
142
+
This package only guarantees the compatibility with the [version v0.24.0 of Meilisearch](https://github.com/meilisearch/Meilisearch/releases/tag/v0.24.0).
143
143
144
144
## Development Workflow and Contributing
145
145
@@ -150,8 +150,8 @@ If you want to know more about the development workflow or want to contribute, p
150
150
## Related Repositories
151
151
152
152
-[docs-searchbar.js](https://github.com/meilisearch/docs-searchbar.js): the library used to display the dropdown of this plugin. It can be useful if you want a search bar for your documentation but you don't use VuePress.
153
-
-[docs-scraper](https://github.com/meilisearch/docs-scraper): the scraper used to scrap websites pages and automatically index the content in MeiliSearch.
153
+
-[docs-scraper](https://github.com/meilisearch/docs-scraper): the scraper used to scrap websites pages and automatically index the content in Meilisearch.
154
154
155
155
<hr>
156
156
157
-
**MeiliSearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.
157
+
**Meilisearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.
0 commit comments