From c0dae0c87348e88d5d8772d829f42f68ef0754ca Mon Sep 17 00:00:00 2001 From: s-pace Date: Fri, 2 Nov 2018 18:23:11 +0100 Subject: [PATCH] format .md --- CONTRIBUTING.md | 8 ++++---- README.md | 1 - cli/oh-my-zsh/README.md | 4 ++-- deployer/README.md | 2 +- 4 files changed, 7 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 79c33dfd..cbffbbb0 100644 --- a/CONTRIBUTING.md +++ b/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 @@ -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 @@ -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 - diff --git a/README.md b/README.md index e64b61c0..153b315f 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/cli/oh-my-zsh/README.md b/cli/oh-my-zsh/README.md index 84d1662c..6941b7ca 100644 --- a/cli/oh-my-zsh/README.md +++ b/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) \ No newline at end of file +- copy the `docsearch` folder in `~/.oh-my-zsh/custom/plugins/` +- enable the plugin in your `zshrc` by modify the plugins variable: ``plugins=([...], docsearch) diff --git a/deployer/README.md b/deployer/README.md index c3742f08..7989ab63 100644 --- a/deployer/README.md +++ b/deployer/README.md @@ -6,4 +6,4 @@ API_KEY="" \ WEBSITE_USERNAME="" \ WEBSITE_PASSWORD="" \ ./deploy -``` \ No newline at end of file +```