📘 The easiest way to add search to your documentation.
accd4f4ba6
* fix wrong idiom * fixing behavior * updating config file * update crawler-overview * update * update * update * update * update * update * update * update * introduce meta * better header handling * better header handling * better header handling * better header handling * better header handling * better header handling * better header handling * fix errors * fix errors * Update docs/src/behavior.md Co-Authored-By: s-pace <sylvain.pace@algolia.com> * Update docs/src/recommended-configuration.md Co-Authored-By: s-pace <sylvain.pace@algolia.com> * Update docs/src/recommended-configuration.md Co-Authored-By: s-pace <sylvain.pace@algolia.com> * Update docs/src/recommended-configuration.md Co-Authored-By: s-pace <sylvain.pace@algolia.com> * fixing facetFilters explanation as reviewed * fix typo * solve equals to |
||
|---|---|---|
| .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