Skip to content

Commit

Permalink
format .md
Browse files Browse the repository at this point in the history
  • Loading branch information
s-pace committed Nov 2, 2018
1 parent 493712a commit c0dae0c
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 8 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
@@ -1,6 +1,5 @@
Hello you,


## Install the scrapper without Docker

We do recommend the use of [pipenv][1] to install the whole python environment
Expand All @@ -10,7 +9,6 @@ We do recommend the use of [pipenv][1] to install the whole python environment

You should be ready to go.


## Run the tests

To run the full test suite, run `./docsearch test`. Note that it requires that
Expand Down Expand Up @@ -47,12 +45,14 @@ DEPLOY_KEY=
Ping the @docsearch team to get access to those credentials.

## Ready to deploy

Clone the configurations repo in your docsearch-scraper directory. Command to run from the scraper root:

```bash
git clone git@github.com:algolia/docsearch-configs.git configs/public
```
The CLI will then have more commands for you to run.

The CLI will then have more commands for you to run.

[1]: https://github.com/pypa/pipenv
[2]: https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv

1 change: 0 additions & 1 deletion README.md
Expand Up @@ -24,7 +24,6 @@ DocSearch is made of 3 repositories:
from your documentation. The code is open-source and you can run it from
a Docker image


[1]: https://community.algolia.com/docsearch/
[2]: https://community.algolia.com/docsearch/run-your-own.html
[3]: https://github.com/algolia/docsearch
Expand Down
4 changes: 2 additions & 2 deletions cli/oh-my-zsh/README.md
@@ -1,4 +1,4 @@
## How to install

- copy the ```docsearch``` folder in ```~/.oh-my-zsh/custom/plugins/```
- enable the plugin in your ```zshrc``` by modify the plugins variable: ``plugins=([...], docsearch)
- copy the `docsearch` folder in `~/.oh-my-zsh/custom/plugins/`
- enable the plugin in your `zshrc` by modify the plugins variable: ``plugins=([...], docsearch)
2 changes: 1 addition & 1 deletion deployer/README.md
Expand Up @@ -6,4 +6,4 @@ API_KEY="" \
WEBSITE_USERNAME="" \
WEBSITE_PASSWORD="" \
./deploy
```
```

0 comments on commit c0dae0c

Please sign in to comment.