nikon/docsearch
1
0
Fork 0
Code Activity Actions

Update installation instructions (#496)

Browse source 
The `./docsearch docker:build` command cannot be run without
previously installing the python dependencies as those dependencies
are needed to run the CLI.
This commit is contained in:
Tim Carry 2018-10-11 18:20:54 +02:00 committed by GitHub
parent 8339e568e2
commit f9a11a0a20
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/src/run-your-own.md
View file

@ -12,12 +12,12 @@ make this even easier for you to use.
## Installation
Start by cloning [the repository][1] and then running `./docsearch docker:build`
to create the local image.
Start by cloning [the repository][1] and then installing the python 2
dependencies using `pip install -r requirements.txt`. This will give you access
to the `./docsearch` command-line tool.
Even if not recommended, you can run DocSearch directly from you host. For that,
you'll need to have `python` and `pip` installed, and then run
`pip install --user -r requirements.txt`.
We then recommend using DocSearch from inside a Docker image. You can setup one
by running `./docsearch docker:build`.
## Configuration
@ -92,7 +92,7 @@ You can test your results by running `./docsearch playground`. This will open a
web page with a search input where you can do live tests against the indexed
results.
![Playground](./assets/playground.png) {mt-2}
![Playground][6] {mt-2}
_Note that if the command fails (it can happen on non-Mac machines), you can get
the same result by running a live server in the `./playground` subdirectory.\`_
@ -127,3 +127,4 @@ hosted version, so you might not need all the listed commands.
[3]: ./config-file.html
[4]: https://github.com/algolia/docsearch-configs/tree/master/configs
[5]: ./dropdown.html
[6]: ./assets/playground.png