<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
<p><strong>Table of Contents</strong>  <em>generated with <a href="https://github.com/thlorenz/doctoc">DocToc</a></em></p>
<ul>
<li><a href="#related-projects">Related projects</a></li>
</ul>
<!-- END doctoc generated TOC please keep comment here to allow auto update -->

<p><a href="https://community.algolia.com/docsearch/"><img src="./.github/docsearch-logo.svg" alt="DocSearch"></a></p>
<p>The easiest way to add search to your documentation. For free.</p>
<p><a href="https://npmjs.org/package/docsearch.js"><img src="https://img.shields.io/npm/v/docsearch.js.svg?style=flat-square" alt="npm version"></a>
<a href="https://travis-ci.org/algolia/docsearch"><img src="https://img.shields.io/travis/algolia/docsearch/master.svg?style=flat-square" alt="build"></a>
<a href="https://coveralls.io/github/algolia/docsearch"><img src="https://img.shields.io/coveralls/algolia/docsearch/master.svg?style=flat-square" alt="coverage"></a>
<a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
<a href="https://npm-stat.com/charts.html?package=docsearch.js"><img src="https://img.shields.io/npm/dm/docsearch.js.svg?style=flat-square" alt="Downloads"></a>
<a href="https://www.jsdelivr.com/package/npm/docsearch.js"><img src="https://data.jsdelivr.com/v1/package/npm/docsearch.js/badge" alt="jsDelivr Hits"></a></p>
<p>DocSearch will crawl your documentation website, push its content to an Algolia
index, and allow you to add a dropdown search menu for your users to find
relevant content in no time.</p>
<p>Check out our <a href="https://community.algolia.com/docsearch/">website</a> for a complete explanation and documentation.</p>
<p><a href="https://community.algolia.com/docsearch/"><img src="./.github/demo.gif" alt="Bootstrap demo"></a></p>
<h2 id="id-related-projects">Related projects</h2>
<p>DocSearch is made of 3 repositories:</p>
<ul>
<li><a href="https://github.com/algolia/docsearch">algolia/docsearch</a> contains the <code>docsearch.js</code> code source and the
documentation website.</li>
<li><a href="https://github.com/algolia/docsearch-configs">algolia/docsearch-configs</a> contains the JSON files representing all the
configs for all the documentations DocSearch is powering</li>
<li><a href="https://github.com/algolia/docsearch-scraper">algolia/docsearch-scraper</a> contains the crawler we use to extract data
from your documentation. The code is open-source and you can run it from
a Docker image</li>
</ul>