antv-l7/node_modules/docsearch.js
thinkinggis f7e5376b7d fix(fix css): fix css png 2019-11-22 18:04:14 +08:00
..
dist fix(fix css): fix css png 2019-11-22 18:04:14 +08:00
node_modules/.bin fix(fix css): fix css png 2019-11-22 18:04:14 +08:00
CHANGELOG.md fix(fix css): fix css png 2019-11-22 18:04:14 +08:00
LICENSE fix(fix css): fix css png 2019-11-22 18:04:14 +08:00
README.md fix(fix css): fix css png 2019-11-22 18:04:14 +08:00
package.json fix(fix css): fix css png 2019-11-22 18:04:14 +08:00

README.md

Table of Contents generated with DocToc

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

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