Documentation

Theme by Meilisearch

|

Updated: 19 May 2025

|

161 Stars

Meilisearch documentation

Overview

The Meilisearch documentation repository is dedicated to the open-source search engine API, Meilisearch. The purpose of this repository is to provide comprehensive documentation for developers who want to use and contribute to the Meilisearch project.

Features

• Open-source Search Engine: Meilisearch is an open-source search engine API that can be integrated into various applications and platforms.
• Contributor-Friendly: The documentation welcomes contributors who wish to improve the Meilisearch project and its accompanying documentation.
• Community Support: Users can join the Meilisearch Discord community for assistance and collaboration.
• Issue Reporting: Users can open issues to provide feedback, suggestions, or report any problems they encounter while using or contributing to Meilisearch.

Installation

To install Meilisearch, follow these steps:

1. Start by cloning the Meilisearch repository from GitHub:

   git clone https://github.com/meilisearch/MeiliSearch.git
   

2. Move into the Meilisearch directory:

   cd MeiliSearch
   

3. Install the dependencies using Yarn:

   yarn
   

4. Build Meilisearch:

   yarn build
   

5. Verify the installation by running the tests:

   yarn test
   

Summary

The Meilisearch documentation repository provides extensive documentation for the open-source search engine API, Meilisearch. It offers a contributor-friendly environment, community support, and issue reporting for users who wish to use and contribute to the project. The installation guide helps users set up Meilisearch in their development environment.