📘 The easiest way to add search to your documentation.
a470c480dd
* feat(ctrl-click): Enable Ctrl-Click on suggestions This updates the underlying autocomplete.js to a version that passes the selection context (click or keyboard) to the `autocomplete:selected` event. With the default `handleSelected, and in the case of a click, it will do nothing (as each suggestion already being a `<a href>`, it will already follow the link), but manually change the location for keyboard navigation. When a custom `handleSelected` is set though, default browser clicks on suggestions are disabled and only `handleSelected` is called. This is to keep backward compatibility with all the live websites that might already use `handleSelected`. * fix(test): Making sure it does not crash when no context is passed |
||
|---|---|---|
| .github | ||
| docs | ||
| scripts | ||
| src | ||
| .babelrc | ||
| .coveralls.yml | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitignore | ||
| .npmignore | ||
| .nvmrc | ||
| .prettierrc | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| index.js | ||
| jest.config.js | ||
| LICENSE | ||
| netlify.toml | ||
| package.json | ||
| README.md | ||
| webpack.config.jsdelivr.babel.js | ||
| webpack.serve.config.babel.js | ||
| yarn.lock | ||
Table of Contents generated with DocToc
The easiest way to add search to your documentation. For free.
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 for a complete explanation and documentation.
Related projects
DocSearch is made of 3 repositories:
- algolia/docsearch contains the
docsearch.jscode source and the documentation website. - algolia/docsearch-configs contains the JSON files representing all the configs for all the documentations DocSearch is powering
- algolia/docsearch-scraper 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