📘 The easiest way to add search to your documentation.
37d39a0297
`printf` displays everything on the same line, and with the way yarn itself outputs its error messages, it would override our custom messages on the terminal, preventing us to know why things failed. Using echo instead fixes the issue. Other fixes are `shellcheck` warnings (`read` without `-r` will fail on input containing `\`). |
||
|---|---|---|
| .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 | ||
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