📘 The easiest way to add search to your documentation.
Permalink
Failed to load latest commit information.
.github docs(readme): Update readme Aug 20, 2018
docs chore(deps): pin dependency markdown-it-classy to 0.2.0 Oct 11, 2018
scripts docs(deploy): Document how to deploy the website (#475) Oct 8, 2018
src chore(lint): Remove .js extension from imports (#483) Oct 5, 2018
.babelrc Move all new docs to docs/ subfolder Aug 20, 2018
.coveralls.yml docs(readme): Add badges Dec 23, 2015
.eslintignore Move all new docs to docs/ subfolder Aug 20, 2018
.eslintrc.js Making the apply form actually post content Aug 20, 2018
.gitignore Auto lint content (#492) Oct 8, 2018
.npmignore chore(package): remove docs from pkg (5M => 300kb) Oct 3, 2016
.nvmrc chore(deps): update node.js to v9.11.2 Jun 17, 2018
.travis.yml docs(deploy): Update deploy documentation system Aug 20, 2018
CHANGELOG.md Doc/update content (#391) Aug 3, 2018
CONTRIBUTING.md Deploy documentation website on push to master Aug 27, 2018
LICENSE feat(docs): new community header / footer (#114) Jun 23, 2016
README.md docs(readme): Add links to other repositories Aug 20, 2018
index.js chore(lint): Remove .js extension from imports (#483) Oct 5, 2018
jest.config.js Update CONTRIBUTING and fix tests Aug 20, 2018
netlify.toml docs(deploy): Document how to deploy the website (#475) Oct 8, 2018
package.json chore(deps): update dependency semver to v5.6.0 Oct 14, 2018
webpack.config.jsdelivr.babel.js chore(stack update): update the whole docsearch stack (#173) Mar 17, 2017
webpack.serve.config.babel.js chore(stack update): update the whole docsearch stack (#173) Mar 17, 2017
yarn.lock chore(deps): update dependency semver to v5.6.0 Oct 14, 2018

README.md

DocSearch

The easiest way to add search to your documentation. For free.

npm version build coverage License Downloads jsDelivr Hits

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.

Bootstrap demo

Related projects

DocSearch is made of 3 repositories:

  • algolia/docsearch contains the docsearch.js code 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