nikon/docsearch
1
0
Fork 0
Code Activity Actions
📘 The easiest way to add search to your documentation.
1090 commits 43 branches 150 tags 129 MiB
TypeScript 50.4%
MDX 32.1%
CSS 8.9%
JavaScript 8.6%
Find a file
renovate[bot] dc94b5301f
chore(deps): update dependency remark-cli to v7.0.1 (#906) 
Co-authored-by: WhiteSource Renovate <renovatebot@gmail.com>
Co-authored-by: Sylvain Pace <sylvain.pace@algolia.com>
2020-01-30 16:53:22 +01:00
.github [Issue template] Provide better guidance and redirection when opening an issue (#500) 2018-10-17 16:35:21 +02:00
docs chore(deps): update dependency remark-cli to v7.0.1 (#906) 2020-01-30 16:53:22 +01:00
scripts docs(deploy-preview): Re-enable deploy previews for the doc 2018-12-14 12:05:41 +01:00
src Typo collumns => columns (#890) 2020-01-20 13:01:50 +01: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 docs(deploy-preview): Re-enable deploy previews for the doc 2018-12-14 12:05:41 +01: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 v10.18.1 (#911) 2020-01-30 16:35:04 +01:00
.prettierrc overridde instead of replace 2018-11-02 17:58:01 +01:00
.travis.yml docs(deploy): Automatic deployment when doc pushed to master 2018-12-03 11:05:42 +01:00
CHANGELOG.md v2.6.3\n\n## [2.6.3](https://github.com/algolia/docsearch/compare/v2.6.2...v2.6.3) (2019-05-13) 2019-05-13 15:45:49 +02:00
CONTRIBUTING.md Remove postinstall (#532) 2018-11-07 17:43:28 +01:00
index.js chore(lint): Remove .js extension from imports (#483) 2018-10-05 12:52:39 +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
netlify.toml docs(deploy-preview): Re-enable deploy previews for the doc 2018-12-14 12:05:41 +01:00
package.json chore(deps): update dependency prettier to v1.19.1 (#905) 2020-01-30 16:53:04 +01:00
README.md Update README.md 2019-05-21 11:41:07 +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
yarn.lock chore(deps): update dependency prettier to v1.19.1 (#905) 2020-01-30 16:53:04 +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