diff --git a/README.md b/README.md index 9fec8f47..b7f01e08 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ We're scratching our own itch here. As developers, we spend a lot of time readin Not blaming anyone here. Building a good search for a documentation is a complex challenge. We happen to have a lot of experience doing that, and we want to share it with the world. For free. -Just submit the form on the [website][12] and we'll get back to you with what you need to integrate your new search into your website. +Just submit the form on the [website][https://community.algolia.com/docsearch/] and we'll get back to you with what you need to integrate your new search into your website. 1. We'll crawl your documentation pages, 2. We'll configure your search experience, @@ -69,7 +69,7 @@ docsearch({ The default colorscheme is blue and gray: -![Default colorscheme][13] +![Default colorscheme][12] To update the colors to suit your website, you just need to override a few colors. Here is an example of a CSS file that you can use as a basis and that @@ -115,7 +115,7 @@ sets white and purples colors. } ``` -Advanced users can also clone the repository, edit the [_variables.scss][14] +Advanced users can also clone the repository, edit the [_variables.scss][13] file and re-build the CSS file using `npm run build:css`. @@ -127,7 +127,7 @@ file and re-build the CSS file using `npm run build:css`. We use a simple documentation example website as a way to develop the docsearch library. Requirements: -- [Node.js][17] +- [Node.js][15] - npm@2 ```sh @@ -148,11 +148,11 @@ npm run dev ### Documentation website -This is the [Jekyll][18] instance running at [https://community.algolia.com/docsearch](https://community.algolia.com/docsearch). +This is the [Jekyll][16] instance running at [https://community.algolia.com/docsearch](https://community.algolia.com/docsearch). Requirements: -- [Ruby][19] -- [Bundler][20] +- [Ruby][17] +- [Bundler][18] ```sh npm run dev:docs @@ -181,12 +181,10 @@ bundle config build.eventmachine --with-cppflags=-I$(brew --prefix openssl)/incl [9]: #local-example [10]: #documentation-website [11]: #macos -[12]: https://community.algolia.com/docsearch/ -[13]: ./docs/img/default-colorscheme.png -[14]: https://github.com/algolia/docsearch/blob/master/src/styles/_variables.scss -[15]: https://github.com/algolia/docsearch/blob/master/dev/docsearch-styling.css -[16]: https://github.com/algolia/docsearch/blob/master/src/styles/_variables.scss -[17]: https://nodejs.org/en/ -[18]: https://jekyllrb.com/ -[19]: https://www.ruby-lang.org/en/ -[20]: http://bundler.io/ +[12]: ./docs/img/default-colorscheme.png +[13]: https://github.com/algolia/docsearch/blob/master/src/styles/_variables.scss +[14]: https://github.com/algolia/docsearch/blob/master/dev/docsearch-styling.css +[15]: https://nodejs.org/en/ +[16]: https://jekyllrb.com/ +[17]: https://www.ruby-lang.org/en/ +[18]: http://bundler.io/ diff --git a/docs/documentation.md b/docs/documentation.md index c2029d3b..6332656f 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -10,7 +10,7 @@ We're scratching our own itch here. As developers, we spend a lot of time readin Not blaming anyone here. Building a good search for a documentation is a complex challenge. We happen to have a lot of experience doing that, and we want to share it with the world. For free. -Just submit the form on the [website][12] and we'll get back to you with what you need to integrate your new search into your website. +Just submit the form on the [website][https://community.algolia.com/docsearch/] and we'll get back to you with what you need to integrate your new search into your website. 1. We'll crawl your documentation pages, 2. We'll configure your search experience, @@ -36,7 +36,7 @@ docsearch({ The default colorscheme is blue and gray: -![Default colorscheme][13] +![Default colorscheme][12] To update the colors to suit your website, you just need to override a few colors. Here is an example of a CSS file that you can use as a basis and that @@ -82,6 +82,6 @@ sets white and purples colors. } ``` -Advanced users can also clone the repository, edit the [_variables.scss][14] +Advanced users can also clone the repository, edit the [_variables.scss][13] file and re-build the CSS file using `npm run build:css`.