52 lines
2.2 KiB
Markdown
52 lines
2.2 KiB
Markdown
|
<!-- 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)*
|
||
|
|
|
||
|
|
- [Related projects](#related-projects)
|
||
|
|
|
||
|
|
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
||
|
|
|
||
|
|
[![DocSearch][1]][8]
|
||
|
|
|
||
|
|
The easiest way to add search to your documentation. For free.
|
||
|
|
|
||
|
|
[![npm version][2]](https://npmjs.org/package/docsearch.js)
|
||
|
|
[![build][3]](https://travis-ci.org/algolia/docsearch)
|
||
|
|
[![coverage][4]](https://coveralls.io/github/algolia/docsearch)
|
||
|
|
[![License][5]](./LICENSE)
|
||
|
|
[![Downloads][6]](https://npm-stat.com/charts.html?package=docsearch.js)
|
||
|
|
[![jsDelivr Hits][7]](https://www.jsdelivr.com/package/npm/docsearch.js)
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
Check out our [website][8] for a complete explanation and documentation.
|
||
|
|
|
||
|
|
[![Bootstrap demo][9]][8]
|
||
|
|
|
||
|
|
## Related projects
|
||
|
|
|
||
|
|
DocSearch is made of 3 repositories:
|
||
|
|
|
||
|
|
- [algolia/docsearch][10] contains the `docsearch.js` code source and the
|
||
|
|
documentation website.
|
||
|
|
- [algolia/docsearch-configs][11] contains the JSON files representing all the
|
||
|
|
configs for all the documentations DocSearch is powering
|
||
|
|
- [algolia/docsearch-scraper][12] 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
|
||
|
|
|
||
|
|
[1]: ./.github/docsearch-logo.svg
|
||
|
|
[2]: https://img.shields.io/npm/v/docsearch.js.svg?style=flat-square
|
||
|
|
[3]: https://img.shields.io/travis/algolia/docsearch/master.svg?style=flat-square
|
||
|
|
[4]: https://img.shields.io/coveralls/algolia/docsearch/master.svg?style=flat-square
|
||
|
|
[5]: https://img.shields.io/badge/license-MIT-green.svg?style=flat-square
|
||
|
|
[6]: https://img.shields.io/npm/dm/docsearch.js.svg?style=flat-square
|
||
|
|
[7]: https://data.jsdelivr.com/v1/package/npm/docsearch.js/badge
|
||
|
|
[8]: https://community.algolia.com/docsearch/
|
||
|
|
[9]: ./.github/demo.gif
|
||
|
|
[10]: https://github.com/algolia/docsearch
|
||
|
|
[11]: https://github.com/algolia/docsearch-configs
|
||
|
|
[12]: https://github.com/algolia/docsearch-scraper
|