Skip to content

Commit

Permalink
Improved contributing (#204)
Browse files Browse the repository at this point in the history
* Improved contributing

* Improved contributing

* Improved contributing
  • Loading branch information
bidoubiwa committed Mar 18, 2020
1 parent 0f9eba7 commit 441d784
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,32 @@
# MeiliSearch documentation

## Requirements

- Yarn

## Installation

```bash
$ npm install -g vuepress
$ git clone git@github.com:meilisearch/documentation.git
$ cd documentation
$ yarn
```

## Launch

### development
### Development
```bash
$ vuepress dev
$ yarn dev
```

# production
### Testing
```bash
$ vuepress build
$ 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 addedd manually to the config file in the right parent directory.
## 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.

0 comments on commit 441d784

Please sign in to comment.