Skip to content
📘 The easiest way to add search to your documentation.
JavaScript CSS Shell HTML
Branch: master
Clone or download

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github fix: use correct url (#936) Feb 25, 2020
scripts docs(deploy-preview): Re-enable deploy previews for the doc Dec 14, 2018
src Typo collumns => columns (#890) Jan 20, 2020
.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 docs(deploy-preview): Re-enable deploy previews for the doc Dec 14, 2018
.npmignore chore(package): remove docs from pkg (5M => 300kb) Oct 3, 2016
.nvmrc chore(deps): update node.js to v10.18.1 (#911) Jan 30, 2020
.prettierrc overridde instead of replace Nov 2, 2018
.travis.yml docs(deploy): Automatic deployment when doc pushed to master Dec 3, 2018
CHANGELOG.md v2.6.3\n\n## [2.6.3](v2.6.2...v2.6.3) (2019-05-13) May 13, 2019
CONTRIBUTING.md Remove postinstall (#532) Nov 7, 2018
LICENSE feat(docs): new community header / footer (#114) Jun 23, 2016
README.md fix: use correct url (#936) Feb 25, 2020
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-preview): Re-enable deploy previews for the doc Dec 14, 2018
package.json Add homepage to package.json (#932) Feb 20, 2020
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): pin dependency tailwindcss to 1.1.2 (#903) Jan 30, 2020

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
You can’t perform that action at this time.