nikon/docsearch
1
0
Fork 0
Code Activity Actions
📘 The easiest way to add search to your documentation.
622 commits 43 branches 150 tags 129 MiB
TypeScript 50.4%
MDX 32.1%
CSS 8.9%
JavaScript 8.6%
Find a file
Pixelastic 6af2dbd485 docs(styling): Fix positioning on Safari
2018-08-23 12:51:50 +02:00
.github docs(readme): Update readme 2018-08-20 16:13:14 +02:00
docs docs(styling): Fix positioning on Safari 2018-08-23 12:51:50 +02:00
scripts docs(deploy): Update deploy documentation system 2018-08-20 13:51:59 +02:00
src Update CONTRIBUTING and fix tests 2018-08-20 13:24:55 +02:00
.babelrc Move all new docs to docs/ subfolder 2018-08-20 13:23:35 +02:00
.coveralls.yml docs(readme): Add badges 2015-12-23 10:47:17 +01:00
.eslintignore Move all new docs to docs/ subfolder 2018-08-20 13:23:35 +02:00
.eslintrc.js Making the apply form actually post content 2018-08-20 13:24:55 +02:00
.gitignore Doc/update content (#419) 2018-08-22 17:02:58 +02:00
.npmignore chore(package): remove docs from pkg (5M => 300kb) 2016-10-03 12:59:48 +02:00
.nvmrc chore(deps): update node.js to v9.11.2 2018-06-17 00:47:58 +00:00
.travis.yml docs(deploy): Update deploy documentation system 2018-08-20 13:51:59 +02:00
CHANGELOG.md Doc/update content (#391) 2018-08-03 10:33:31 +02:00
CONTRIBUTING.md docs(contributing): Update contributing info about docs 2018-08-20 13:53:31 +02:00
index.js fix(build): fix badly handled webpack upgrade 2017-03-27 18:30:17 +02:00
jest.config.js Update CONTRIBUTING and fix tests 2018-08-20 13:24:55 +02:00
LICENSE feat(docs): new community header / footer (#114) 2016-06-23 19:13:16 +02:00
package.json Add Markdown linting 2018-08-22 20:08:49 +02:00
README.md docs(readme): Add links to other repositories 2018-08-20 17:14:23 +02:00
webpack.config.jsdelivr.babel.js chore(stack update): update the whole docsearch stack (#173) 2017-03-17 16:22:00 +01:00
webpack.serve.config.babel.js chore(stack update): update the whole docsearch stack (#173) 2017-03-17 16:22:00 +01:00

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