Skip to content

Commit 2073eec

Browse files
lint markdown
1 parent 72e6690 commit 2073eec

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+77
-99
lines changed

.markdownlint.jsonc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
2+
"MD001": true, // heading-increment/header-increment Heading levels should only increment by one level at a time
23
"MD013": false, // line-length Line length [Expected: 80; Actual: 119]
3-
"MD001": false, // heading-increment/header-increment Heading levels should only increment by one level at a time
4-
"MD026": {"punctuation": ".,;:。,;"}, // no-trailing-punctuation Trailing punctuation in headings except ? and !
54
"MD014": false, // commands-show-output Dollar signs used before commands without showing output
65
"MD024": false, // no-duplicate-heading/no-duplicate-header
76
"MD025": {"front_matter_title": "(?!.*)"}, // single-title/single-h1 Accept both h1 and front matter titles
8-
"MD040": false, // fenced-code-language Fenced code blocks should have a language specified
97
"MD033": false, // no-inline-html Inline HTML
8+
"MD034": false, // allow bare URLs
9+
"MD040": false, // fenced-code-language Fenced code blocks should have a language specified
1010
"MD049": { "style": "underscore" }, // enforce use of underscore for em/italics
1111
"MD050": { "style": "asterisk" }, // enforce use of asterisk for strong/bold
1212
"MD051": false

.markdownlintignore

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
node_modules
2-
.vuepress
3-
public
2+
scripts
3+
snippets
4+
assets
45
README.md

.vale/styles/Vocab/word_list/accept.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,4 +111,5 @@ masterKey
111111
GCP
112112
Boolean
113113
GET
114-
POST
114+
POST
115+
Mintlify

guides/ai/mcp.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,6 @@ Can you check the connection to my Meilisearch instance and tell me what version
7676

7777
Claude will use the `get-version` and `health-check` tools to verify the connection and provide information about your instance.
7878

79-
8079
## Create an e-commerce index
8180

8281
Now you have configured the MCP to work with Meilisearch, you can use it to manage your indexes.
@@ -157,7 +156,7 @@ Search the "products" index for "chair" where the price is less than 200 and the
157156

158157
### Important note about LLM limitation
159158

160-
Large Language Models like Claude tend to say "yes" to most requests, even if they can't actually perform them.
159+
Large Language Models like Claude tend to say "yes" to most requests, even if they can't actually perform them.
161160

162161
Claude can only perform actions that are exposed through the Meilisearch API and implemented in the MCP server. If you're unsure whether a particular operation is possible, refer to the [Meilisearch documentation](https://docs.meilisearch.com) and the [MCP server README](https://github.com/meilisearch/meilisearch-mcp).
163162
</Warning>
@@ -197,4 +196,4 @@ npx @modelcontextprotocol/inspector uvx -n meilisearch-mcp
197196

198197
The Meilisearch MCP integration with Claude can transform multiple API calls and configuration tasks into conversational requests. This can help you focus more on building your application and less on implementation details.
199198

200-
For more information about advanced configurations and capabilities, refer to the [Meilisearch documentation](https://docs.meilisearch.com) and the [Meilisearch MCP server repository](https://github.com/meilisearch/meilisearch-mcp).
199+
For more information about advanced configurations and capabilities, refer to the [Meilisearch documentation](https://docs.meilisearch.com) and the [Meilisearch MCP server repository](https://github.com/meilisearch/meilisearch-mcp).

guides/deployment/aws.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ If you have an existing Key Pair, you can use that. Otherwise, select the option
112112

113113
Once you've downloaded your key pair (and only then), click on "Launch Instances", then on "View Instances".
114114

115-
### 9. Enjoy your Meilisearch instance running on AWS!
115+
### 9. Enjoy your Meilisearch instance running on AWS
116116

117117
Your instance may take a minute or two to get up and running (see the "Instance state" column).
118118

guides/embedders/cohere.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ To follow this guide, you'll need:
2020
To set up an embedder in Meilisearch, you need to configure it to your settings. You can refer to the [Meilisearch documentation](/reference/api/settings) for more details on updating the embedder settings.
2121

2222
Cohere offers multiple embedding models:
23+
2324
- `embed-english-v3.0` and `embed-multilingual-v3.0`: 1024 dimensions
2425
- `embed-english-light-v3.0` and `embed-multilingual-light-v3.0`: 384 dimensions
2526

guides/front_end/front_end_integration.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ In the [quick start tutorial](/learn/self_hosted/getting_started_with_self_hoste
77

88
Using [`instant-meilisearch`](https://github.com/meilisearch/instant-meilisearch) is the easiest way to build a front-end interface for search. `instant-meilisearch` is a plugin that establishes communication between a Meilisearch instance and [InstantSearch](https://github.com/algolia/instantsearch.js). InstantSearch, an open-source project developed by Algolia, renders all the components needed to start searching.
99

10-
## Let's try it!
11-
1210
1. Create an empty file and name it `index.html`
1311
2. Open it in a text editor like Notepad, Sublime Text, or Visual Studio Code
1412
3. Copy-paste one the code sample below

guides/front_end/vue_quick_start.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ The `ais-instant-search` widget is the mandatory wrapper that allows you to conf
6969

7070
## 5. Add a search bar and list search results
7171

72-
Add the `ais-search-box` and `ais-hits` widgets inside the `ais-instant-search` wrapper widget.
72+
Add the `ais-search-box` and `ais-hits` widgets inside the `ais-instant-search` wrapper widget.
7373

7474
Import the CSS library to style the search components.
7575

@@ -79,11 +79,11 @@ Import the CSS library to style the search components.
7979
<ais-search-box />
8080
<ais-hits>
8181
<template v-slot:item="{ item }">
82-
<div>
83-
<img :src="item.image" align="left" :alt="item.name"/>
82+
<div>
83+
<img :src="item.image" align="left" :alt="item.name"/>
8484
<h2>{{ item.name }}</h2>
85-
<p> {{ item.description }}</p>
86-
</div>
85+
<p> {{ item.description }}</p>
86+
</div>
8787
</template>
8888
</ais-hits>
8989
</ais-instant-search>
@@ -93,7 +93,6 @@ Import the CSS library to style the search components.
9393
import { instantMeiliSearch } from "@meilisearch/instant-meilisearch";
9494
import "instantsearch.css/themes/satellite-min.css";
9595
96-
9796
export default {
9897
data() {
9998
return {

guides/improve_relevancy_large_documents.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,6 @@ Users searching this dataset will now be able to find more relevant results acro
130130

131131
## Conclusion
132132

133-
You have seen how to split large documents to improve search relevancy. You also saw how to configure a distinct attribute to prevent Meilisearch from returning duplicate results.
133+
You have seen how to split large documents to improve search relevancy. You also saw how to configure a distinct attribute to prevent Meilisearch from returning duplicate results.
134134

135135
Though this guide used JavaScript, you can replicate the process with any programming language you are comfortable using.

guides/laravel_multitenancy.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This guide will walk you through implementing search in a multitenant Laravel ap
88
## Requirements
99

1010
This guide requires:
11+
1112
- A Laravel 10 application with [Laravel Scout](https://laravel.com/docs/10.x/scout) configured to use the `meilisearch` driver
1213
- A Meilisearch server running — see our [quick start](/learn/getting_started/cloud_quick_start)
1314
- A search API key — available in your Meilisearch dashboard
@@ -22,6 +23,7 @@ Prefer self-hosting? Read our [installation guide](/learn/self_hosted/install_me
2223
Our example CRM is a multitenant application, where each user can only access data belonging to their organization.
2324

2425
On a technical level, this means:
26+
2527
- A `User` model that belongs to an `Organization`
2628
- A `Contact` model that belongs to an `Organization` (can only be accessed by users from the same organization)
2729
- An `Organization` model that has many `User`s and many `Contact`s

0 commit comments

Comments
 (0)