nikon/docsearch
1
0
Fork 0
Code Activity Actions

Merge pull request #28 from algolia/docs/tweaks

Browse source 
docs(readme): Small rewording
This commit is contained in:
Tim Carry 2015-12-21 16:56:31 +01:00
commit b39d0d3770
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -23,15 +23,15 @@ We've created the fastest, easiest way to search within documentation. Check out
## Introduction
We're scratching our own itch here. As developers, we spend a lot of time reading documentation, and it isn’t always easy to find the information we need.
We're scratching our own itch here. As developers, we spend a lot of time reading documentation, and it isn't always easy to find the information we need.
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 [community.algolia.com/docsearch/](https://community.algolia.com/docsearch/) website 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,
3. and you'll need to add the a small JS/CSS code snippet to your website.
3. You'll need to add a bit of JavaScript and CSS code to your website.
## Setup
@ -53,7 +53,7 @@ docSearch({
To customize the look & feel of the dropdown menu, you can either:
* edit the color [variables](https://github.com/algolia/docsearch/blob/master/src/styles/_variables.scss) and rebuild this project CSS,
* edit the color [variables](https://github.com/algolia/docsearch/blob/master/src/styles/_variables.scss) and rebuild this project CSS (`npm run build:css`),
* or override the colors like we did in [dev/docsearch-styling.css](https://github.com/algolia/docsearch/blob/master/dev/docsearch-styling.css).
<!-- END documentation.md -->
@ -74,7 +74,7 @@ npm run dev
### Documentation website
This is the [Jekyll](https://jekyllrb.com/) instance running at https://community.algolia.com/docsearch.
This is the [Jekyll](https://jekyllrb.com/) instance running at [https://community.algolia.com/docsearch](https://community.algolia.com/docsearch).
Requirements:
- [Ruby](https://www.ruby-lang.org/en/)