Skip to content

Commit 9968414

Browse files
authored
Merge branch 'main' into bump-meilisearch-v0.25.0
2 parents 4a48943 + d1eda1d commit 9968414

File tree

6 files changed

+26
-26
lines changed

6 files changed

+26
-26
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If applicable, add screenshots or logs to help explain your problem.
2222

2323
**Environment (please complete the following information):**
2424
- OS: [e.g. Debian GNU/Linux]
25-
- MeiliSearch version: [e.g. v.0.20.0]
25+
- Meilisearch version: [e.g. v.0.20.0]
2626
- vuepress-plugin-meilisearch version: [e.g v0.10.7]
2727
- Browser: [e.g. Chrome version 90.0]
2828
- VuePress version: [e.g. v1.8.2]

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing <!-- omit in TOC -->
22

3-
First of all, thank you for contributing to MeiliSearch! The goal of this document is to provide everything you need to know in order to contribute to MeiliSearch and its different integrations.
3+
First of all, thank you for contributing to Meilisearch! The goal of this document is to provide everything you need to know in order to contribute to Meilisearch and its different integrations.
44

55
- [Assumptions](#assumptions)
66
- [How to Contribute](#how-to-contribute)
@@ -11,8 +11,8 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
1111
## Assumptions
1212

1313
1. **You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.**
14-
2. **You've read the MeiliSearch [documentation](https://docs.meilisearch.com) and the [README](/README.md).**
15-
3. **You know about the [MeiliSearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.**
14+
2. **You've read the Meilisearch [documentation](https://docs.meilisearch.com) and the [README](/README.md).**
15+
3. **You know about the [Meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.**
1616

1717
## How to Contribute
1818

@@ -92,7 +92,7 @@ Some notes on GitHub PRs:
9292

9393
## Release Process (for internal team only)
9494

95-
MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/).
95+
Meilisearch tools follow the [Semantic Versioning Convention](https://semver.org/).
9696

9797
### Automation to Rebase and Merge the PRs <!-- omit in TOC -->
9898

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2020-2021 MeiliSearch
3+
Copyright (c) 2020-2021 Meilisearch
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<p align="center">
2-
<img src="https://res.cloudinary.com/meilisearch/image/upload/v1587402338/SDKs/meilisearch_vuepress.svg" alt="MeiliSearch-VuePress" width="200" height="200" />
2+
<img src="https://raw.githubusercontent.com/meilisearch/integration-guides/main/assets/logos/meilisearch_vuepress.svg" alt="Meilisearch-VuePress" width="200" height="200" />
33
</p>
44

5-
<h1 align="center">MeiliSearch VuePress</h1>
5+
<h1 align="center">Meilisearch VuePress</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> |
@@ -20,17 +20,17 @@
2020
<a href="https://app.bors.tech/repositories/28907"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
2121
</p>
2222

23-
<p align="center">⚡ The MeiliSearch plugin for VuePress</p>
23+
<p align="center">⚡ The Meilisearch plugin for VuePress</p>
2424

25-
**MeiliSearch VuePress** is a **MeiliSearch** plugin for VuePress.
25+
**Meilisearch VuePress** is a **Meilisearch** plugin for VuePress.
2626

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)
2828

2929
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).
3030

31-
![MeiliSearch docs demo](assets/docs-searchbar-demo.gif).
31+
![Meilisearch docs demo](assets/docs-searchbar-demo.gif).
3232

33-
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/).
3434

3535
## Table of Contents <!-- omit in toc -->
3636

@@ -39,15 +39,15 @@ This plugin is used in production on the [MeiliSearch documentation](https://doc
3939
- [Installation](#installation)
4040
- [Basic Configuration](#basic-configuration)
4141
- [Customization](#customization)
42-
- [Compatibility with MeiliSearch](#compatibility-with-meilisearch)
42+
- [Compatibility with Meilisearch](#compatibility-with-meilisearch)
4343
- [Development Workflow and Contributing](#development-workflow-and-contributing)
4444
- [Related Repositories](#related-repositories)
4545

4646
## Usage
4747

4848
### Before using the plugin
4949

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.
5151

5252
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) 🚀
5353

@@ -61,8 +61,8 @@ yarn playground
6161

6262
Then, open your browser on the indicated URL and test the search bar 🙂
6363

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).
6666

6767
### Installation
6868

@@ -93,8 +93,8 @@ module.exports = {
9393
}
9494
```
9595

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).
9898

9999
### Customization
100100

@@ -137,9 +137,9 @@ $dropdownBgDarkColor
137137

138138
You can also find an example in our [playground's `palette.styl` file](./playground/.vuepress/styles/palette.styl)
139139

140-
## Compatibility with MeiliSearch
140+
## Compatibility with Meilisearch
141141

142-
This package only guarantees the compatibility with the [version v0.25.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.25.0).
142+
This package only guarantees the compatibility with the [version v0.25.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.25.0).
143143

144144
## Development Workflow and Contributing
145145

@@ -150,8 +150,8 @@ If you want to know more about the development workflow or want to contribute, p
150150
## Related Repositories
151151

152152
- [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.
154154

155155
<hr>
156156

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.

playground/.vuepress/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ module.exports = {
1313
[
1414
require('../../index.js'),
1515
{
16-
// Testing with MeiliSearch documentation content (https://docs.meilisearch.com/)
16+
// Testing with Meilisearch documentation content (https://docs.meilisearch.com/)
1717
hostUrl: 'https://docs-search-bar.meilisearch.com',
1818
apiKey:
1919
'd79226ae89f29d4dadba8d0c30c240e435f584fb83a7ae573b13eb62edec35cd',

playground/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# MeiliSearch and vuepress
1+
# Meilisearch and vuepress
22

33
Use the search bar to test the plugin!
44

0 commit comments

Comments
 (0)