Skip to content

📘 The easiest way to add search to your documentation.

License

Notifications You must be signed in to change notification settings

willpatera/docsearch

 
 

Repository files navigation

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

About

📘 The easiest way to add search to your documentation.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 65.0%
  • CSS 26.0%
  • Shell 7.6%
  • HTML 1.4%