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
**docs-scraper** is a scraper for your documentation website that indexes the scraped content into a **MeiliSearch** instance.
22
+
**docs-scraper** is a scraper for your documentation website that indexes the scraped content into a **Meilisearch** instance.
23
23
24
-
**MeiliSearch** is an open-source search engine. [Discover what MeiliSearch is!](https://github.com/meilisearch/MeiliSearch)
24
+
**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/Meilisearch)
25
25
26
-
This scraper is used in production and runs on the [MeiliSearch documentation](https://docs.meilisearch.com/) on each deployment.
26
+
This scraper is used in production and runs on the [Meilisearch documentation](https://docs.meilisearch.com/) on each deployment.
27
27
28
-
💡 If you already have your own scraper but you still want to use MeiliSearch and our [front-end tools](#-and-for-the-front-end-search-bar), check out [this discussion](https://github.com/meilisearch/docs-searchbar.js/issues/40).
28
+
💡 If you already have your own scraper but you still want to use Meilisearch and our [front-end tools](#-and-for-the-front-end-search-bar), check out [this discussion](https://github.com/meilisearch/docs-searchbar.js/issues/40).
29
29
30
30
## Table of Contents <!-- omit in TOC -->
31
31
32
32
-[⚙️ Usage](#️-usage)
33
-
-[Run your MeiliSearch Instance](#run-your-meilisearch-instance)
33
+
-[Run your Meilisearch Instance](#run-your-meilisearch-instance)
34
34
-[Set your Config File](#set-your-config-file)
35
35
-[Run the Scraper](#run-the-scraper)
36
36
-[🖌 And for the front-end search bar?](#-and-for-the-front-end-search-bar)
@@ -53,7 +53,7 @@ This scraper is used in production and runs on the [MeiliSearch documentation](h
-[🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
56
+
-[🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
57
57
-[⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
58
58
-[Credits](#credits)
59
59
@@ -62,27 +62,27 @@ This scraper is used in production and runs on the [MeiliSearch documentation](h
62
62
63
63
Here are the 3 steps to use `docs-scraper`:
64
64
65
-
1.[Run a MeiliSearch instance](#run-your-meilisearch-instance)
65
+
1.[Run a Meilisearch instance](#run-your-meilisearch-instance)
66
66
2.[Set your config file](#set-your-config-file)
67
67
3.[Run the scraper](#run-the-scraper)
68
68
69
-
### Run your MeiliSearch Instance
69
+
### Run your Meilisearch Instance
70
70
71
-
Your documentation content needs to be scraped and pushed into a MeiliSearch instance.
71
+
Your documentation content needs to be scraped and pushed into a Meilisearch instance.
72
72
73
-
You can install and run MeiliSearch on your machine using `curl`.
73
+
You can install and run Meilisearch on your machine using `curl`.
74
74
75
75
```bash
76
76
curl -L https://install.meilisearch.com | sh
77
77
./meilisearch --master-key=myMasterKey
78
78
```
79
79
80
-
There are [other ways to install MeiliSearch](https://docs.meilisearch.com/learn/tutorials/getting_started.html#download-and-launch).
80
+
There are [other ways to install Meilisearch](https://docs.meilisearch.com/learn/tutorials/getting_started.html#download-and-launch).
81
81
82
-
The host URL and the API key you will provide in the next steps correspond to the credentials of this MeiliSearch instance.
82
+
The host URL and the API key you will provide in the next steps correspond to the credentials of this Meilisearch instance.
83
83
In the example above, the host URL is `http://localhost:7700` and the API key is `myMasterKey`.
84
84
85
-
_MeiliSearch is open-source and can run either on your server or on any cloud provider. Here is a tutorial to [run MeiliSearch in production](https://docs.meilisearch.com/running-production/)._
85
+
_Meilisearch is open-source and can run either on your server or on any cloud provider. Here is a tutorial to [run Meilisearch in production](https://docs.meilisearch.com/running-production/)._
86
86
87
87
88
88
### Set your Config File
@@ -117,7 +117,7 @@ Here is an example of a basic config file:
117
117
}
118
118
}
119
119
```
120
-
The `index_uid` field is the index identifier in your MeiliSearch instance in which your website content is stored. The scraping tool will create a new index if it does not exist.
120
+
The `index_uid` field is the index identifier in your Meilisearch instance in which your website content is stored. The scraping tool will create a new index if it does not exist.
121
121
122
122
The `docs-content` class (the `.` means this is a class) is the main container of the textual content in this example. Most of the time, this tag is a `<main>` or an `<article>` HTML element.
123
123
@@ -163,7 +163,7 @@ docker run -t --rm \
163
163
164
164
`<absolute-path-to-your-config-file>` should be the absolute path of your configuration file defined at the [previous step](#set-your-config-file).
165
165
166
-
⚠️ If you run MeiliSearch locally, you must add the `--network=host` option to this Docker command.
166
+
⚠️ If you run Meilisearch locally, you must add the `--network=host` option to this Docker command.
167
167
168
168
#### In a GitHub Action <!-- omit in TOC -->
169
169
@@ -190,14 +190,14 @@ run-scraper:
190
190
191
191
⚠️ We do not recommend using the `latest` image in production. Use the [release tags](https://github.com/meilisearch/docs-scraper/releases) instead.
192
192
193
-
Here is the [GitHub Action file](https://github.com/meilisearch/documentation/blob/master/.github/workflows/gh-pages-scraping.yml) we use in production for the MeiliSearch documentation.
193
+
Here is the [GitHub Action file](https://github.com/meilisearch/documentation/blob/master/.github/workflows/gh-pages-scraping.yml) we use in production for the Meilisearch documentation.
194
194
195
195
#### About the API Key <!-- omit in TOC -->
196
196
197
-
The API key you must provide should have the permissions to add documents into your MeiliSearch instance.<br>
197
+
The API key you must provide should have the permissions to add documents into your Meilisearch instance.<br>
198
198
In a production environment, we recommend providing the private key instead of the master key, as it is safer and it has enough permissions to perform such requests.
199
199
200
-
_More about [MeiliSearch authentication](https://docs.meilisearch.com/reference/features/authentication.html)._
200
+
_More about [Meilisearch authentication](https://docs.meilisearch.com/reference/features/authentication.html)._
201
201
202
202
## 🖌 And for the front-end search bar?
203
203
@@ -256,7 +256,7 @@ Your data will be displayed with a main title (`lvl0`), sub-titles (`lvl1`), sub
256
256
257
257
#### `index_uid`
258
258
259
-
The `index_uid` field is the index identifier in your MeiliSearch instance in which your website content is stored. The scraping tool will create a new index if it does not exist.
259
+
The `index_uid` field is the index identifier in your Meilisearch instance in which your website content is stored. The scraping tool will create a new index if it does not exist.
260
260
261
261
```json
262
262
{
@@ -411,7 +411,7 @@ This can be used to remove a table of content, a sidebar, or a footer, to make o
411
411
412
412
#### `custom_settings` (optional)
413
413
414
-
This field can be used to add MeiliSearch settings.
414
+
This field can be used to add Meilisearch settings.
415
415
416
416
```json
417
417
"custom_settings": {
@@ -528,9 +528,9 @@ If you set the environment variables `KC_URL`, `KC_REALM`, `KC_CLIENT_ID`, and `
528
528
Websites that need JavaScript for rendering are passed through ChromeDriver.<br>
529
529
[Download the version](http://chromedriver.chromium.org/downloads) suited to your OS and then set the environment variable `CHROMEDRIVER_PATH`.
530
530
531
-
## 🤖 Compatibility with MeiliSearch
531
+
## 🤖 Compatibility with Meilisearch
532
532
533
-
This package only guarantees the compatibility with the [version v0.25.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.25.0).
533
+
This package only guarantees the compatibility with the [version v0.25.0 of Meilisearch](https://github.com/meilisearch/Meilisearch/releases/tag/v0.25.0).
534
534
535
535
## ⚙️ Development Workflow and Contributing
536
536
@@ -545,4 +545,4 @@ Due to a lot of future changes on this repository compared to the original one,
545
545
546
546
<hr>
547
547
548
-
**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.
548
+
**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