meilisearch4docs v1.0.0

MeiliSearch4Docs

The best way to handle your search bar documentation with MeiliSearch.

• Development Workflow
  • Requirements
  • Install
  • Build
  • Serve
  • Test
• Contributing
• Credits

Development Workflow

Requirements

To run this project, you will need:

• Node.js >= v8.7.0, use nvm - install instructions
• Yarn

Install

Install all the dependencies:

$ yarn install

Build

Run:

$ yarn run build

This command will build all files in ./dist. This includes regular and minified files for <script> inclusion, as well as classes for importing.

The command itself is split into yarn run build:js and yarn run build:css if you want to build a subset.

Serve

Set the env var $BROWSER. This variable will be use in ${BROWSER} scripts/playground.html to open the playground.

Then run:

$ yarn run serve

Now, you can have all this files served on localhost, along with live-reload.

Test

Run:

# Run all the tests:
$ yarn run test
# With auto-reload:
$ yarn run test:watch

Contributing

Every help is appreciated, and we would be happy to guide you with your contribution.

2 main steps:

• Have a fix or a new feature? Search for corresponding issues first then create a new one.

• Follow the steps in development workflow to run the project.

Don't hesitate if you have any question. You can create an issue and start a discussion, or contact us at bonjour@meilisearch.com.

All the MeiliSearch team thanks for your interest! ♥️

Credits

Based on Algolia DocSearch repository from this commit. Due to a lot of future changes on this repository compared to the original one, we don't maintain it as an official fork.