📘 The easiest way to add search to your documentation.
c0f64d2c76
* Adding new logo I reverted to the previous way of displaying the logo, as a background SVG image. Adding a new `<svg>` inline element to the markup could break people implementation relying on our markup, so better play safe and keep the markup the same. I used the SVG available on our https://www.algolia.com/press#resources page, but trimmed it through SVGO (50% compression) before adding it to the background. * Updating logo to version validated by design team Original dimensions are 168x24, but this is substancially bigger than what we used to have (130x19px). InstantSearch used a 134x20px ratio, and I re-used the same. Slightly bigger than what we had before, but keeping the correct ratio. |
||
|---|---|---|
| .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