MeiliSearch Documentation

This repository is the documentation for the open-source search engine API MeiliSearch.

Contributing

Hey, thank you so much for wanting to contribute! If you'd like to help improve this documentation, we'd love to have you! If you think something is missing or could be improved, issues are highly appreciated.

Before contributing, please leave a comment on an issue letting us know you're interested. Only submit a Pull Request after you have been assigned a corresponding issue.

See something wrong that's not on the list? Great! Open a new issue describing the problem and tell us you want to work on it.

To contribute, clone this repository, commit your changes and open a pull request.

Hacktoberfest

It's Hacktoberfest month! 🥳

🚀 If your PR gets accepted it will count into your participation to Hacktoberfest!

✅ To be accepted it has either to have been merged, approved or tagged with the hacktoberfest-accepted label.

🧐 Don't forget to check the quality standards! Low-quality PRs might get marked as spam or invalid, and will not count toward your participation in Hacktoberfest.

Requirements

Node version >= v10 and < v15

Installing & Running

# Clone the repository
$ git clone git@github.com:meilisearch/documentation.git meilisearch-documentation
# Open the newly created directory
cd meilisearch-documentation
# Install dependencies
$ yarn install
# Run MeiliSearch documentation on https://localhost:8080
$ yarn dev

Testing

A complete test can be done using the following command:

$ yarn test

The tests are triggered on build and on any pull request to master.

Checking dead links

Making changes to the documentation without creating any dead links can be a tedious task. Before submitting any pull request, you can check the dead links.

$ yarn check-links

Checking Styling

The documentation follows styling rules. The following files will be checked: *.vue, *.js, and *.md.

You can check out and fix the styling errors.

$ yarn style:fix

You can test if the code is well-formatted without fixing it.

$ yarn style

Deployment

The documentation is deployed as a static website. The master branch is automatically deployed at https://docs.meilisearch.com.

You can build the static website using the following command:

$ yarn build
# The website is now available in .vuepress/dist and you can serve it using any webserver.

Contact

Feel free to contact us about any questions you may have:

Join our Slack community.
Open an issue!

Any suggestion or feedback is highly appreciated. Thank you for your support!

Rutam21/documentation