vuepress-plugin-meilisearch
Advanced tools
Comparing version
# Contributing <!-- omit in TOC --> | ||
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. | ||
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. | ||
@@ -14,4 +14,4 @@ - [Assumptions](#assumptions) | ||
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.** | ||
2. **You've read the MeiliSearch [documentation](https://docs.meilisearch.com) and the [README](/README.md).** | ||
3. **You know about the [MeiliSearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.** | ||
2. **You've read the Meilisearch [documentation](https://docs.meilisearch.com) and the [README](/README.md).** | ||
3. **You know about the [Meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.** | ||
@@ -96,3 +96,3 @@ ## How to Contribute | ||
MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/). | ||
Meilisearch tools follow the [Semantic Versioning Convention](https://semver.org/). | ||
@@ -99,0 +99,0 @@ ### Automation to Rebase and Merge the PRs <!-- omit in TOC --> |
{ | ||
"name": "vuepress-plugin-meilisearch", | ||
"version": "0.11.4", | ||
"version": "0.11.5", | ||
"description": "Relevant and typo tolerant search bar for your Vuepress", | ||
@@ -14,3 +14,3 @@ "author": "Clémentine Urquizar <clementine@meilisearch.com>", | ||
"dependencies": { | ||
"docs-searchbar.js": "^2.0.1" | ||
"docs-searchbar.js": "^2.1.0" | ||
}, | ||
@@ -17,0 +17,0 @@ "resolutions": { |
@@ -16,3 +16,3 @@ module.exports = { | ||
{ | ||
// Testing with MeiliSearch documentation content (https://docs.meilisearch.com/) | ||
// Testing with Meilisearch documentation content (https://docs.meilisearch.com/) | ||
hostUrl: 'https://docs-search-bar.meilisearch.com', | ||
@@ -19,0 +19,0 @@ apiKey: |
@@ -1,2 +0,2 @@ | ||
# MeiliSearch and vuepress | ||
# Meilisearch and vuepress | ||
@@ -3,0 +3,0 @@ Use the search bar to test the plugin! |
<p align="center"> | ||
<img src="https://res.cloudinary.com/meilisearch/image/upload/v1587402338/SDKs/meilisearch_vuepress.svg" alt="MeiliSearch-VuePress" width="200" height="200" /> | ||
<img src="https://raw.githubusercontent.com/meilisearch/integration-guides/main/assets/logos/meilisearch_vuepress.svg" alt="Meilisearch-VuePress" width="200" height="200" /> | ||
</p> | ||
<h1 align="center">MeiliSearch VuePress</h1> | ||
<h1 align="center">Meilisearch VuePress</h1> | ||
<h4 align="center"> | ||
<a href="https://github.com/meilisearch/MeiliSearch">MeiliSearch</a> | | ||
<a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> | | ||
<a href="https://docs.meilisearch.com">Documentation</a> | | ||
@@ -23,13 +23,13 @@ <a href="https://slack.meilisearch.com">Slack</a> | | ||
<p align="center">⚡ The MeiliSearch plugin for VuePress</p> | ||
<p align="center">⚡ The Meilisearch plugin for VuePress</p> | ||
**MeiliSearch VuePress** is a **MeiliSearch** plugin for VuePress. | ||
**Meilisearch VuePress** is a **Meilisearch** plugin for VuePress. | ||
**MeiliSearch** is an open-source search engine. [Discover what MeiliSearch is!](https://github.com/meilisearch/MeiliSearch) | ||
**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch) | ||
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/). | ||
This plugin is used in production on the [Meilisearch documentation](https://docs.meilisearch.com/). | ||
@@ -43,3 +43,3 @@ ## Table of Contents <!-- omit in toc --> | ||
- [Customization](#customization) | ||
- [Compatibility with MeiliSearch](#compatibility-with-meilisearch) | ||
- [Compatibility with Meilisearch](#compatibility-with-meilisearch) | ||
- [Development Workflow and Contributing](#development-workflow-and-contributing) | ||
@@ -52,3 +52,3 @@ - [Related Repositories](#related-repositories) | ||
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. | ||
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. | ||
@@ -67,4 +67,4 @@ 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) 🚀 | ||
The data comes from MeiliSearch documentation.<br> | ||
Type `create an indxe` to live the MeiliSearch experience with the [typo tolerance](https://docs.meilisearch.com/reference/under_the_hood/typotolerance.html). | ||
The data comes from Meilisearch documentation.<br> | ||
Type `create an indxe` to live the Meilisearch experience with the [typo tolerance](https://docs.meilisearch.com/reference/under_the_hood/typotolerance.html). | ||
@@ -100,4 +100,4 @@ ### Installation | ||
**WARNING**: Since the configuration file is public, we recommend providing the MeiliSearch public key, which is enough to perform searches.<br> | ||
Read more about [MeiliSearch authentication](https://docs.meilisearch.com/reference/features/authentication.html#authentication). | ||
**WARNING**: Since the configuration file is public, we recommend providing the Meilisearch public key, which is enough to perform searches.<br> | ||
Read more about [Meilisearch authentication](https://docs.meilisearch.com/reference/features/authentication.html#authentication). | ||
@@ -145,5 +145,5 @@ ### Customization | ||
## Compatibility with MeiliSearch | ||
## Compatibility with Meilisearch | ||
This package only guarantees the compatibility with the [version v0.24.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.24.0). | ||
This package only guarantees the compatibility with the [version v0.25.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.25.0). | ||
@@ -159,6 +159,6 @@ ## Development Workflow and Contributing | ||
- [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. | ||
- [docs-scraper](https://github.com/meilisearch/docs-scraper): the scraper used to scrap websites pages and automatically index the content in MeiliSearch. | ||
- [docs-scraper](https://github.com/meilisearch/docs-scraper): the scraper used to scrap websites pages and automatically index the content in Meilisearch. | ||
<hr> | ||
**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. | ||
**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. |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Deprecated
MaintenanceThe maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.
Found 1 instance in 1 package
13415421
01
Infinity%Updated