Skip to content

Commit 777f1a3

Browse files
bidoubiwabidoubiwa
committed
Update MeiliSearch naming to Meilisearch
1 parent 89e9ef1 commit 777f1a3

File tree

9 files changed

+75
-97
lines changed

9 files changed

+75
-97
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,6 @@ If applicable, add screenshots or logs to help explain your problem.
2323
**Environment (please complete the following information):**
2424

2525
- OS: [e.g. Debian GNU/Linux]
26-
- MeiliSearch version: [e.g. v.0.20.0]
26+
- Meilisearch version: [e.g. v.0.20.0]
2727
- docs-searchbar.js version: [e.g v1.1.11]
2828
- Browser: [e.g. Chrome version 90.0]

‎README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<p align="center">
2-
<img src="assets/logo.svg" alt="Meilisearch" width="200" height="200" />
2+
<img src="https://github.com/meilisearch/integration-guides/blob/main/assets/logos/logo.svg" alt="Meilisearch" width="200" height="200" />
33
</p>
44

55
<h1 align="center">docs-searchbar.js</h1>
66

77
<h4 align="center">
8-
<a href="https://github.com/meilisearch/Meilisearch">Meilisearch</a> |
8+
<a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
99
<a href="https://docs.meilisearch.com">Documentation</a> |
1010
<a href="https://slack.meilisearch.com">Slack</a> |
1111
<a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
@@ -22,7 +22,7 @@
2222

2323
**docs-searchbar.js** is a front-end SDK for **Meilisearch** to handle your search bar documentation.
2424

25-
**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/Meilisearch)
25+
**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)
2626

2727
![docs-searchbar.js example](/assets/docs-searchbar-example.png)
2828

@@ -321,7 +321,7 @@ Here is the [CSS customization](https://github.com/meilisearch/vuepress-plugin-m
321321

322322
## 🤖 Compatibility with Meilisearch
323323

324-
This package only guarantees the compatibility with the [version v0.24.0 of Meilisearch](https://github.com/meilisearch/Meilisearch/releases/tag/v0.24.0).
324+
This package only guarantees the compatibility with the [version v0.24.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.24.0).
325325

326326
## ⚙️ Development Workflow and Contributing
327327

‎assets/logo.svg

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "docs-searchbar.js",
33
"version": "2.0.1",
4-
"description": "Add a relevant search bar to your documentation using MeiliSearch",
4+
"description": "Add a relevant search bar to your documentation using Meilisearch",
55
"keywords": [
66
"documentation",
77
"searchbar",
@@ -28,7 +28,7 @@
2828
"files": [
2929
"dist/"
3030
],
31-
"author": "MeiliSearch <[email protected]> (https://github.com/meilisearch/)",
31+
"author": "Meilisearch <[email protected]> (https://github.com/meilisearch/)",
3232
"license": "MIT",
3333
"repository": "meilisearch/docs-searchbar.js",
3434
"devDependencies": {

‎playgrounds/html/index.html

Lines changed: 59 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,67 @@
11
<!DOCTYPE html>
22
<html lang="en">
3-
<head>
4-
<meta charset="utf-8" />
5-
<meta name="color-scheme" content="dark light" />
6-
<title>Docs SearchBar playground</title>
7-
<link
8-
rel="stylesheet"
9-
href="https://cdn.jsdelivr.net/bootstrap/3.3.6/css/bootstrap.min.css"
10-
/>
11-
<link rel="stylesheet" href="../../src/styles/main.scss" />
12-
</head>
13-
<body>
14-
<div class="container">
15-
<div class="col-md-12">
16-
<input
17-
type="search"
18-
placeholder="docs-searchbar input"
19-
class="form-control"
20-
id="q"
21-
/>
22-
</div>
3+
4+
<head>
5+
<meta charset="utf-8" />
6+
<meta name="color-scheme" content="dark light" />
7+
<title>Docs SearchBar playground</title>
8+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/bootstrap/3.3.6/css/bootstrap.min.css" />
9+
<link rel="stylesheet" href="../../src/styles/main.scss" />
10+
</head>
11+
12+
<body>
13+
<div class="container">
14+
<div class="col-md-12">
15+
<input type="search" placeholder="docs-searchbar input" class="form-control" id="q" />
2316
</div>
24-
<!-- at the end of the BODY -->
25-
<script src="../../index.js"></script>
26-
<script>
27-
docsSearchBar.default({
28-
// Test with MeiliSearch Documentation
29-
hostUrl: 'https://docs-search-bar.meilisearch.com',
30-
apiKey:
31-
'd79226ae89f29d4dadba8d0c30c240e435f584fb83a7ae573b13eb62edec35cd',
32-
indexUid: 'docs',
33-
inputSelector: '#q',
34-
handleSelected(input, event, suggestion, datasetNumber, context) {
35-
console.info(input)
36-
console.info(event)
37-
console.info(suggestion)
38-
console.info(datasetNumber)
39-
console.info(context)
40-
},
41-
debug: true, // Set debug to true if you want to inspect the dropdown
42-
enhancedSearchInput: true,
43-
enableDarkMode: true
44-
})
45-
</script>
46-
<style>
47-
.container {
48-
margin: 10%;
49-
}
17+
</div>
18+
<!-- at the end of the BODY -->
19+
<script src="../../index.js"></script>
20+
<script>
21+
docsSearchBar.default({
22+
// Test with Meilisearch Documentation
23+
hostUrl: 'https://docs-search-bar.meilisearch.com',
24+
apiKey:
25+
'd79226ae89f29d4dadba8d0c30c240e435f584fb83a7ae573b13eb62edec35cd',
26+
indexUid: 'docs',
27+
inputSelector: '#q',
28+
handleSelected(input, event, suggestion, datasetNumber, context) {
29+
console.info(input)
30+
console.info(event)
31+
console.info(suggestion)
32+
console.info(datasetNumber)
33+
console.info(context)
34+
},
35+
debug: true, // Set debug to true if you want to inspect the dropdown
36+
enhancedSearchInput: true,
37+
enableDarkMode: true
38+
})
39+
</script>
40+
<style>
41+
.container {
42+
margin: 10%;
43+
}
5044

51-
div [data-ds-theme] .searchbox {
52-
width: 60%;
53-
margin: auto;
54-
margin-top: 10%;
55-
display: block;
56-
}
45+
div [data-ds-theme] .searchbox {
46+
width: 60%;
47+
margin: auto;
48+
margin-top: 10%;
49+
display: block;
50+
}
5751

58-
div [data-ds-theme] .searchbox input {
59-
height: 34px;
60-
border-radius: 4px;
61-
font-size: 14px;
62-
}
52+
div [data-ds-theme] .searchbox input {
53+
height: 34px;
54+
border-radius: 4px;
55+
font-size: 14px;
56+
}
6357

64-
@media (prefers-color-scheme: dark) {
65-
body {
66-
background-color: #152028;
67-
color: #eaeaea;
68-
}
58+
@media (prefers-color-scheme: dark) {
59+
body {
60+
background-color: #152028;
61+
color: #eaeaea;
6962
}
70-
</style>
71-
</body>
63+
}
64+
</style>
65+
</body>
66+
7267
</html>

‎playgrounds/javascript/src/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import docsSearchBar from '../../../index'
22
import '../../../src/styles/main.scss'
33

44
docsSearchBar({
5-
// Test with MeiliSearch Documentation
5+
// Test with Meilisearch Documentation
66
hostUrl: 'https://docs-search-bar.meilisearch.com',
77
apiKey: 'd79226ae89f29d4dadba8d0c30c240e435f584fb83a7ae573b13eb62edec35cd',
88
indexUid: 'docs',

‎src/lib/DocsSearchBar.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ import { MeiliSearch } from 'meilisearch'
77
/**
88
* Adds an autocomplete dropdown to an input field
99
* @function DocsSearchBar
10-
* @param {string} options.hostUrl URL where MeiliSearch instance is hosted
10+
* @param {string} options.hostUrl URL where Meilisearch instance is hosted
1111
* @param {string} options.apiKey Read-only API key
1212
* @param {string} options.indexUid UID of the index to target
1313
* @param {string} options.inputSelector CSS selector that targets the input
1414
* @param {boolean} [options.debug] When set to true, the dropdown will not be closed on blur
15-
* @param {Object} [options.meilisearchOptions] Options to pass the underlying MeiliSearch client
16-
* @param {function} [options.queryDataCallback] This function will be called when querying MeiliSearch
15+
* @param {Object} [options.meilisearchOptions] Options to pass the underlying Meilisearch client
16+
* @param {function} [options.queryDataCallback] This function will be called when querying Meilisearch
1717
* @param {Object} [options.autocompleteOptions] Options to pass to the underlying autocomplete instance
1818
* @param {function} [options.transformData] An optional function to transform the hits
1919
* @param {function} [options.queryHook] An optional function to transform the query
@@ -329,7 +329,7 @@ class DocsSearchBar {
329329

330330
/**
331331
* Returns the `source` method to be passed to autocomplete.js. It will query
332-
* the MeiliSearch index and call the callbacks with the formatted hits.
332+
* the Meilisearch index and call the callbacks with the formatted hits.
333333
* @function getAutocompleteSource
334334
* @param {function} transformData An optional function to transform the hits
335335
* @param {function} queryHook An optional function to transform the query

‎src/lib/__tests__/DocsSearchBar-test.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,7 @@ describe('DocsSearchBar', () => {
461461
})
462462

463463
describe('the returned function', () => {
464-
it('calls the MeiliSearch client with the correct parameters', () => {
464+
it('calls the Meilisearch client with the correct parameters', () => {
465465
// Given
466466
const actual = docsSearchBar.getAutocompleteSource()
467467

@@ -485,7 +485,7 @@ describe('DocsSearchBar', () => {
485485
})
486486

487487
describe('when queryHook is used', () => {
488-
it('calls the MeiliSearch client with the correct parameters', () => {
488+
it('calls the Meilisearch client with the correct parameters', () => {
489489
// Given
490490
const actual = docsSearchBar.getAutocompleteSource(
491491
false,

‎src/lib/utils.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ const utils = {
238238
* }, 'text');
239239
* =>
240240
* '<em>foo</em>'
241-
* @param {object} object Hit object returned by the MeiliSearch API
241+
* @param {object} object Hit object returned by the Meilisearch API
242242
* @param {string} property Object key to look for
243243
* @return {string}
244244
**/
@@ -277,7 +277,7 @@ const utils = {
277277
* }, 'text');
278278
* =>
279279
* '<em>This is an unfinished sentence</em>…'
280-
* @param {object} object Hit object returned by the MeiliSearch API
280+
* @param {object} object Hit object returned by the Meilisearch API
281281
* @param {string} property Object key to look for
282282
* @return {string}
283283
**/

0 commit comments

Comments
 (0)