diff --git a/README.md b/README.md index 3f92af53f8..09ab9343c1 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,36 @@ -# MeiliSearch Documentation +# MeiliSearch documentation -MeiliSearch is a **RESTful search API** that is the **ready-to-go solution** for everyone wanting a **powerful, fast, and relevant search experience** for their end-users ⚡️🔎 +This repository contains the documentation for [MeiliSearch](https://github.com/meilisearch/meilisearch), an open-source search engine API. -[](/guides/introduction/quick_start_guide.md) +## Contributing -Efficient search engines are often only accessible to companies with the financial means and resources necessary to develop a search solution adapted to their needs. The majority of other companies that do not have the means or do not realize that the lack of relevance of a search greatly impacts the pleasure of navigation on their application, -end up with poor solutions that are more frustrating than effective, for both the developer and the user. +Want to contribute to the documentation of MeiliSearch? You can do so by cloning this repository, making your change and submitting your pull request. -That's why we created MeiliSearch, an open-source solution accessible to everyone, meeting the vast majority of needs, even specific ones. Installable very easily with little or no configuration required but with a high capacity for customization. +### Install & Run -Our solution is **instant**; it **accepts typos**; it understands **filters**, **custom rankings**, and a lot of other [features](/#features). +```bash +# Clone the repository +$ git clone git@github.com:meilisearch/documentation.git meilisearch-documentation && cd meilisearch-documentation +# Install dependencies +$ yarn install +# Run MeiliSearch documentation on https://localhost:8080 +$ yarn dev +``` -[](/resources/faq.md) +#### Check dead links -## Open-source +It can be tough to make changes to the documentation without creating any dead links. You can check the dead links before making any pull request +```bash +$ yarn check-links +``` -MeiliSearch is open-source. You can **support the project by starring** it on [our GitHub](https://github.com/meilisearch/MeiliSearch)! +### Deployment -Star -Fork - +The documentation is deployed as a static website. Master branch is automatically deployed to [https://docs.meilisearch.com](https://docs.meilisearch.com). -## Demo +You can build the static website using the following command -![crates.io demo gif](/crates-io-demo.gif) -> Meili helps the Rust community find crates on [crates.meilisearch.com](https://crates.meilisearch.com) - -## Alternatives - -Why should you use MeiliSearch instead of any other existing solution? If it is clear to us, it may not be for you. We try to answer this question in this article on [comparison to alternatives](/resources/comparison_to_alternatives.md). - -## Features - -* **Instant Search** (answers < 50ms): Priority on fast answers for smooth search experience. -* **Search as you type** (*prefix search*): Results are updated on each keystroke. To make this possible, we use a [prefix-search](/guides/advanced_guides/prefix.md#prefix-search). -* [Typo tolerance](/guides/advanced_guides/typotolerance.md#typo-tolerance): Understands typo and spelling mistakes. -* [Tokenization](https://en.wikipedia.org/wiki/Lexical_analysis#Tokenization) in English, kanji and latin based languages. -* **Return the whole document**: The entire document is returned upon search. -* **Highly customizable search and indexation**: - - [Custom ranking](/guides/main_concepts/relevancy.md): Customize the relevancy of the search engine and the ranking of the search results. - - [Stop words](/guides/advanced_guides/stop_words.md): Ignore common non-relevant words like `of` or `the`. - - [Highlights](/guides/advanced_guides/search_parameters.md#attributes-to-highlight): Highlighted search results in documents - - Ability to create [synonyms](/guides/advanced_guides/synonyms.md) for a better search experience. -* **RESTful API** -* **Friendly web interface**: [Integrated web interface](/guides/advanced_guides/web_interface) in MeiliSearch that lets you try the search engine when developing. +```bash +$ yarn build +# The website is now available in .vuepress/dist and you can serve it using any webserver. +``` diff --git a/contributing.md b/contributing.md deleted file mode 100644 index 066e4f0891..0000000000 --- a/contributing.md +++ /dev/null @@ -1,32 +0,0 @@ -# MeiliSearch documentation - -## Requirements - -- Yarn - -## Installation - -```bash -$ git clone git@github.com:meilisearch/documentation.git -$ cd documentation -$ yarn -``` - -## Launch - -### Development -```bash -$ yarn dev -``` - -### Testing -```bash -$ yarn check-links -``` -This test will check all links in the documentation. If some dead links are found the tests will fail. - - -## Changing the documentation - -Directory structure can be changed in `.vuepress/config.js`. Every file needs to be added manually to the config file in the right parent directory. - diff --git a/index.md b/index.md new file mode 100644 index 0000000000..cbf360ee47 --- /dev/null +++ b/index.md @@ -0,0 +1,46 @@ +# MeiliSearch Documentation + +MeiliSearch is a **RESTful search API** that is the **ready-to-go solution** for everyone wanting a **powerful, fast, and relevant search experience** for their end-users ⚡️🔎 + +[](/guides/introduction/quick_start_guide.md) + +Efficient search engines are often only accessible to companies with the financial means and resources necessary to develop a search solution adapted to their needs. The majority of other companies that do not have the means or do not realize that the lack of relevance of a search greatly impacts the pleasure of navigation on their application, +end up with poor solutions that are more frustrating than effective, for both the developer and the user. + +That's why we created MeiliSearch, an open-source solution accessible to everyone, meeting the vast majority of needs, even specific ones. Installable very easily with little or no configuration required but with a high capacity for customization. + +Our solution is **instant**; it **accepts typos**; it understands **filters**, **custom rankings**, and a lot of other [features](#features). + +[](/resources/faq.md) + +## Open-source + +MeiliSearch is open-source. You can **support the project by starring** it on [our GitHub](https://github.com/meilisearch/MeiliSearch)! + +Star +Fork + + +## Demo + +![crates.io demo gif](/crates-io-demo.gif) +> Meili helps the Rust community find crates on [crates.meilisearch.com](https://crates.meilisearch.com) + +## Alternatives + +Why should you use MeiliSearch instead of any other existing solution? If it is clear to us, it may not be for you. We try to answer this question in this article on [comparison to alternatives](/resources/comparison_to_alternatives.md). + +## Features + +* **Instant Search** (answers < 50ms): Priority on fast answers for smooth search experience. +* **Search as you type** (*prefix search*): Results are updated on each keystroke. To make this possible, we use a [prefix-search](/guides/advanced_guides/prefix.md#prefix-search). +* [Typo tolerance](/guides/advanced_guides/typotolerance.md#typo-tolerance): Understands typo and spelling mistakes. +* [Tokenization](https://en.wikipedia.org/wiki/Lexical_analysis#Tokenization) in English, kanji and latin based languages. +* **Return the whole document**: The entire document is returned upon search. +* **Highly customizable search and indexation**: + - [Custom ranking](/guides/main_concepts/relevancy.md): Customize the relevancy of the search engine and the ranking of the search results. + - [Stop words](/guides/advanced_guides/stop_words.md): Ignore common non-relevant words like `of` or `the`. + - [Highlights](/guides/advanced_guides/search_parameters.md#attributes-to-highlight): Highlighted search results in documents + - Ability to create [synonyms](/guides/advanced_guides/synonyms.md) for a better search experience. +* **RESTful API** +* **Friendly web interface**: [Integrated web interface](/guides/advanced_guides/web_interface) in MeiliSearch that lets you try the search engine when developing.