Skip to content

Commit

Permalink
chore(docs): updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
redox committed Dec 18, 2015
1 parent 698ee1b commit fab0e5b
Showing 1 changed file with 39 additions and 43 deletions.
82 changes: 39 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,75 @@
# DocSearch

[![build status](https://travis-ci.org/algolia/docsearch.svg?branch=master)](http://travis-ci.org/algolia/docsearch)
[![NPM version](https://badge.fury.io/js/docsearch.js.svg)](http://badge.fury.io/js/docsearch.js)

We've created the fastest, easiest way to search within documentation. Check out our [website](https://community.algolia.com/docsearch/) to add an outstanding search to your documentation.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
## Table of Contents

- [docsearch](#docsearch)
- [Usage](#usage)
- [Examples](#examples)
- [How do I get an `apiKey` and `indexName`?](#how-do-i-get-an-apikey-and-indexname)
- [How does it work?](#how-does-it-work)
- [Introduction](#introduction)
- [Setup](#setup)
- [Customization](#customization)
- [Development workflow](#development-workflow)
- [Local example](#local-example)
- [Documentation website](#documentation-website)
- [MacOS](#macos)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# docsearch
## 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.

Add a search autocomplete to any documentation.
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.

Currently on-demand, send an email to [docsearch@algolia.com](mailto:docsearch@algolia.com)
if you want documentation search on your website.
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.

# Usage
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.

## Setup

Once we've crawled your documentation website we'll send you the credentials you need to add the following code snippet to your website:

```html
<link rel="stylesheet" href="//cdn.jsdelivr.net/docsearch.js/0/docsearch.min.css" />
<script src="//cdn.jsdelivr.net/docsearch.js/0/docsearch.min.js"></script>
```

```js
documentationSearch({
apiKey: apiKey, // Mandatory
indexName: indexName, // Mandatory
inputSelector: '#search-input' // Mandatory
<script type="text/javascript" src="//cdn.jsdelivr.net/docsearch.js/0/docsearch.min.js"></script>
<script type="text/javascript">
docSearch({
apiKey: '<API_KEY>',
indexName: '<INDEX_NAME>',
inputSelector: '<YOUR_INPUT_DOM_SELECTOR>'
});
</script>
```

# Examples

- http://eslint.org/
- https://bootstrap.algolia.com/
- https://reactjs.algolia.com/
- https://babeljs.algolia.com/

# How do I get an `apiKey` and `indexName`?

Send us [an email](mailto:docsearch@algolia.com) with the url of
the documentation website you would like to add search to.
## Customization

# How does it work?
To customize the look & feel of the dropdown menu, you can either:

The JavaScript library is a wrapper on top of our
[autocomplete.js](https://github.com/algolia/autocomplete.js) library, along
with default CSS styling of the dropdown.
* edit the color [variables](https://github.com/algolia/docsearch/blob/master/src/styles/_variables.scss) and rebuild this project CSS,
* or override the colors like we did in [dev/docsearch-styling.css](https://github.com/algolia/docsearch/blob/master/dev/docsearch-styling.css).

The indexing of the website data itself is currently done by an internal tool (to be released).
## Development workflow

Indexing of websites using docsearch takes places every day.

# Development workflow

## Local example
### Local example

We use a simple documentation example website as a way to develop the docsearch.js library.

Requirements:
- [Node.js](https://nodejs.org/en/)
- npm@2

```sh
npm run dev
# open http://localhost:8080
```

## Documentation website
### Documentation website

This is the [Jekyll](https://jekyllrb.com/) instance running at https://community.algolia.com/docsearch.

Expand All @@ -86,7 +82,7 @@ npm run dev:docs
# open http://localhost:4000/docsearch/
```

## MacOS
### MacOS

If you are using `brew` and you had `brew install openssl`, you may need to configure the build path of eventmachine with

Expand Down

0 comments on commit fab0e5b

Please sign in to comment.