Remove dollar signs from code examples

Author: bidoubiwa

.code-samples.meilisearch.yaml

@@ -290,7 +290,8 @@ getting_started_add_documents_md: |-
   ```bash
   npm install meilisearch
   ```
-  Or
+
+  Or, if you are using `yarn`
   ```bash
   yarn add meilisearch
   ```

CONTRIBUTING.md

@@ -33,7 +33,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
 ### Setup
 
 ```bash
-$ yarn --dev
+yarn --dev
 ```
 
 ### Tests and Linter
@@ -42,15 +42,15 @@ Each PR should pass the tests and the linter to be accepted.
 
 ```bash
 # Tests
-$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
-$ docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
-$ yarn test
+docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
+docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
+yarn test
 # Linter
-$ yarn style
+yarn style
 # Linter with fixing
-$ yarn style:fix
+yarn style:fix
 # Build the project
-$ yarn build
+yarn build
 ```
 
 ## Git Guidelines

README.md

@@ -62,8 +62,8 @@ There are many easy ways to [download and run a MeiliSearch instance](https://do
 For example, if you use Docker:
 
 ```bash
-$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
-$ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
+docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
+docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
 ```
 
 NB: you can also download MeiliSearch from **Homebrew** or **APT**.

examples/browser/README.md

@@ -5,8 +5,8 @@
 Build the base project `/meilisearch-js` as this example uses the locally build bundles from `meilisearch-js`.
 
 ```
-$ cd meilisearch-js
-$ yarn build
+cd meilisearch-js
+yarn build
 ```
 
 ## Credentials

examples/node/README.md

@@ -5,8 +5,8 @@
 Build the base project `/meilisearch-js` as this example uses the locally build bundles from `meilisearch-js`.
 
 ```
-$ cd meilisearch-js
-$ yarn build
+cd meilisearch-js
+yarn build
 ```
 
 ## Credentials

examples/node/small_index.js

@@ -10,27 +10,44 @@ const client = new MeiliSearch(config)
 const uid = 'movies_test'
 
 const dataset = [
-  { id: 123, title: 'Pride and Prejudice', comment: 'A great book' },
+  { biduleidbidule: "ahaha", id: 123, title: 'Pride and Prejudice', comment: 'A great book' },
   {
+    biduleidbidule: "ahaha2",
     id: 456,
     title: 'Le Petit Prince',
     comment: 'A french book about a prince that walks on little cute planets',
   },
-  { id: 2, title: 'Le Rouge et le Noir', comment: 'Another french book' },
-  { id: 1, title: 'Alice In Wonderland', comment: 'A weird book' },
-  { id: 1344, title: 'The Hobbit', comment: 'An awesome book' },
+  { biduleidbidule: "ahaha3", id: 2, title: 'Le Rouge et le Noir', comment: 'Another french book' },
+  { biduleidbidule: "ahaha4", id: 1, title: 'Alice In Wonderland', comment: 'A weird book' },
+  { biduleidbidule: "ahaha5", id: 1344, title: 'The Hobbit', comment: 'An awesome book' },
   {
+    biduleidbidule: "ahaha6",
     id: 4,
     title: 'Harry Potter and the Half-Blood Prince',
     comment: 'The best book',
   },
-  { id: 42, title: "The Hitchhiker's Guide to the Galaxy" },
+  { biduleidbidule: "ahaha7", id: 42, title: "The Hitchhiker's Guide to the Galaxy" },
 ]
 
 ;(async () => {
-  // This example creates an index with 7 documents
-  const index = await client.getOrCreateIndex(uid)
-  const { updateId } = await index.addDocuments(dataset)
-  const res = await index.waitForPendingUpdate(updateId)
-  console.log({ res })
+  try {
+    // This example creates an index with 7 documents
+    // console.log(await client.getKeys())
+    await client.deleteIndex(uid)
+    const index = await client.getOrCreateIndex(uid, {
+      // primaryKey: "id"
+    })
+    // const update = await client.updateIndex(uid, {
+    //   primaryKey: "test_id"
+    // })
+    const { updateId } = await index.addDocuments(dataset)
+    const res = await index.waitForPendingUpdate(updateId)
+    // console.log({ res })
+    // const docs = await index.search("harry")
+    // console.log(docs.hits)
+    const i = await client.index(uid).getRawInfo()
+    console.log(i)
+  } catch(e) {
+    console.log(e)
+  }
 })()

examples/typescript-browser/README.md

@@ -5,8 +5,8 @@
 Build the base project `/meilisearch-js` as this example uses the locally build bundles from `meilisearch-js`.
 
 ```
-$ cd meilisearch-js
-$ yarn build
+cd meilisearch-js
+yarn build
 ```
 
 ## Credentials
@@ -22,19 +22,19 @@ To try it out you need to follow these steps.
 ### 1. Install dependencies
 
 ```bash
-$ yarn
+yarn
 ```
 
 ### 2. Build
 
 ```bash
-$ yarn build
+yarn build
 ```
 
 ### 3. Serve
 
 ```bash
-$ http-server public
+http-server public
 ```
 
 We used http-server CLI to serve the webpage. Feel free to use any tool with the same purpose as it will not impact the result.

examples/typescript-node/README.md

@@ -5,8 +5,8 @@
 Build the base project `/meilisearch-js` as this example uses the locally build bundles from `meilisearch-js`.
 
 ```
-$ cd meilisearch-js
-$ yarn build
+cd meilisearch-js
+yarn build
 ```
 
 ## Credentials
@@ -22,17 +22,17 @@ To try it out you need to follow these steps:
 ### 1. Install dependencies
 
 ```bash
-$ yarn
+yarn
 ```
 
 ### 2. Build
 
 ```bash
-$ yarn build
+yarn build
 ```
 
 ### 3. Execute
 
 ```bash
-$ node build/bundle.js
+node build/bundle.js
 ```