-
Notifications
You must be signed in to change notification settings - Fork 228
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Improved contributing * Improved contributing * Improved contributing
- Loading branch information
Showing
1 changed file
with
14 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|