{"id":13406403,"url":"https://github.com/algolia/docsearch","last_synced_at":"2026-02-17T23:13:34.209Z","repository":{"id":37695355,"uuid":"46591278","full_name":"algolia/docsearch","owner":"algolia","description":":blue_book: The easiest way to add search to your documentation.","archived":false,"fork":false,"pushed_at":"2026-02-13T15:15:50.000Z","size":90749,"stargazers_count":4331,"open_issues_count":98,"forks_count":436,"subscribers_count":97,"default_branch":"main","last_synced_at":"2026-02-13T23:54:00.538Z","etag":null,"topics":["algolia","docsearch","documentation","javascript","react","search","typescript"],"latest_commit_sha":null,"homepage":"https://docsearch.algolia.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/algolia.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2015-11-20T22:55:10.000Z","updated_at":"2026-02-13T21:30:06.000Z","dependencies_parsed_at":"2022-08-08T21:16:07.110Z","dependency_job_id":"7eb01f9c-06a8-42f2-8167-ea24ac6dc415","html_url":"https://github.com/algolia/docsearch","commit_stats":{"total_commits":1604,"total_committers":118,"mean_commits":13.59322033898305,"dds":0.8185785536159601,"last_synced_commit":"e52c8f343570625eadec8f2da2c58f9f58edbdfe"},"previous_names":[],"tags_count":120,"template":false,"template_full_name":null,"purl":"pkg:github/algolia/docsearch","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Fdocsearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Fdocsearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Fdocsearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Fdocsearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/algolia","download_url":"https://codeload.github.com/algolia/docsearch/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Fdocsearch/sbom","scorecard":{"id":183237,"data":{"date":"2025-08-11","repo":{"name":"github.com/algolia/docsearch","commit":"69983f95848ab79e5ac3ffff73c01f849a5637db"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.7,"checks":[{"name":"Code-Review","score":4,"reason":"Found 13/30 approved changesets -- score normalized to 4","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 3 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/renovate.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: cypress/downloads/downloads.html:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/renovate.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/algolia/docsearch/renovate.yml/main?enable=pin","Info:   0 out of   1 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v4.0.0-beta.4 not signed: https://api.github.com/repos/algolia/docsearch/releases/234313250","Warn: release artifact v4.0.0-beta.4 does not have provenance: https://api.github.com/repos/algolia/docsearch/releases/234313250"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 20 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"30 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx","Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99","Warn: Project is vulnerable to: GHSA-f7f6-9jq7-3rqj","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-4www-5p9h-95mh","Warn: Project is vulnerable to: GHSA-9gqv-wp59-fq42","Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-x7hr-w5r2-h6wg","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx","Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-x574-m823-4x7w","Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8","Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x","Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4","Warn: Project is vulnerable to: GHSA-859w-5945-r5v3","Warn: Project is vulnerable to: GHSA-9crc-q9x8-hgqq","Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v","Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-16T19:16:29.741Z","repository_id":37695355,"created_at":"2025-08-16T19:16:29.741Z","updated_at":"2025-08-16T19:16:29.741Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29561825,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-17T21:50:49.831Z","status":"ssl_error","status_checked_at":"2026-02-17T21:46:15.313Z","response_time":100,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["algolia","docsearch","documentation","javascript","react","search","typescript"],"created_at":"2024-07-30T19:02:29.343Z","updated_at":"2026-02-17T23:13:34.204Z","avatar_url":"https://github.com/algolia.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n\n[![DocSearch](.github/logo.svg)](https://docsearch.algolia.com)\n\nThe easiest way to add search to your documentation – for free.\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/30eacc09-d4b2-4a53-879b-04d40aaea454/deploy-status)](https://app.netlify.com/sites/docsearch/deploys) [![npm version](https://img.shields.io/npm/v/@docsearch/js.svg?style=flat-square)](https://www.npmjs.com/package/@docsearch/js/v/alpha) [![Used by](https://img.shields.io/endpoint?style=flat-square\u0026url=https://api.usedby.dev/npm/@docsearch/js/shield.json)](https://github.com/algolia/docsearch/network/dependents) [![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat-square)](./LICENSE)\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003e\n  \u003ca href=\"https://docsearch.algolia.com\"\u003eDocumentation\u003c/a\u003e •\n  \u003ca href=\"https://codesandbox.io/s/docsearchjs-v3-playground-z9oxj\"\u003eJavaScript Playground\u003c/a\u003e •\n  \u003ca href=\"https://codesandbox.io/s/docsearch-react-v3-playground-619yg\"\u003eReact Playground\u003c/a\u003e\n  \u003c/strong\u003e\n\u003c/p\u003e\n\n\u003c/div\u003e\n\n---\n\nDocSearch crawls your documentation, pushes the content to an Algolia index and provides a dropdown search experience on your website.\n\n## Preview\n\n![Ask AI demo](packages/website/static/img/resources/askai_demo.gif)\n\n## Usage\n\n\u003e Don't have your Algolia credentials yet? [Apply to DocSearch](https://docsearch.algolia.com/apply)!\n\n### JavaScript\n\n#### Installation\n\n```sh\nyarn add @docsearch/js@4\n# or\nnpm install @docsearch/js@4\n```\n\nIf you don’t want to use a package manager, you can use a standalone endpoint:\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/@docsearch/js@4\"\u003e\u003c/script\u003e\n```\n\n#### Get started\n\nTo get started, you need a [`container`](https://docsearch.algolia.com/docs/api#container) for your DocSearch component to go in. If you don’t have one already, you can insert one into your markup:\n\n```html\n\u003cdiv id=\"docsearch\"\u003e\u003c/div\u003e\n```\n\nThen, insert DocSearch into it by calling the [`docsearch`](https://docsearch.algolia.com/docs/api) function and providing the container. It can be a [CSS selector](https://developer.mozilla.org/en-us/docs/web/css/css_selectors) or an [Element](https://developer.mozilla.org/en-us/docs/web/api/htmlelement).\n\nMake sure to provide a [`container`](https://docsearch.algolia.com/docs/api#container) (for example, a `div`), not an `input`. DocSearch generates a fully accessible search box for you.\n\n```js app.js\nimport docsearch from '@docsearch/js';\n\nimport '@docsearch/css';\n\ndocsearch({\n  container: '#docsearch',\n  appId: 'YOUR_APP_ID',\n  indexName: 'YOUR_INDEX_NAME',\n  apiKey: 'YOUR_SEARCH_API_KEY',\n});\n```\n\n### React\n\n#### Installation\n\n```bash\nyarn add @docsearch/react@4\n# or\nnpm install @docsearch/react@4\n```\n\nIf you don’t want to use a package manager, you can use a standalone endpoint:\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/@docsearch/react@4\"\u003e\u003c/script\u003e\n```\n\n#### Get started\n\nDocSearch generates a fully accessible search box for you.\n\n```jsx App.js\nimport { DocSearch } from '@docsearch/react';\n\nimport '@docsearch/css';\n\nfunction App() {\n  return (\n    \u003cDocSearch\n      appId=\"YOUR_APP_ID\"\n      apiKey=\"YOUR_SEARCH_API_KEY\"\n      indices=[\"YOUR_ALGOLIA_INDEX\"]\n    /\u003e\n  );\n}\n\nexport default App;\n```\n\n## Styling\n\n[Read documentation →](https://docsearch.algolia.com/docs/styling)\n\n## Related projects\n\nDocSearch is made of the following repositories:\n\n- **[algolia/docsearch](https://github.com/algolia/docsearch)**: DocSearch source code.\n- **[algolia/docsearch/packages/website](https://github.com/algolia/docsearch/tree/main/packages/website)**: DocSearch website and documentation.\n- **[algolia/docsearch-configs](https://github.com/algolia/docsearch-configs)**: DocSearch websites configurations that DocSearch powers.\n- **[algolia/docsearch-scraper](https://github.com/algolia/docsearch-scraper)**: DocSearch crawler that extracts data from your documentation.\n\n## Used by\n\nDocSearch is used by [Bootstrap](https://github.com/twbs/bootstrap), [Cheerio](https://github.com/cheeriojs/cheerio), [Element Plus](https://github.com/element-plus/element-plus), [Authelia](https://github.com/authelia/authelia), [MDX](https://github.com/mdx-js/mdx), [VitePress](https://github.com/vuejs/vitepress) and [many more](https://github.com/algolia/docsearch/network/dependents).\n\n[![Used by](https://api.usedby.dev/npm/@docsearch/js?max=50\u0026sort=stars)](https://github.com/algolia/docsearch/network/dependents)\nGenerated with [usedby.dev](https://usedby.dev/)\n\n## License\n\n[MIT](LICENSE)\n","funding_links":[],"categories":["TypeScript","JavaScript","MDX","typescript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgolia%2Fdocsearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falgolia%2Fdocsearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgolia%2Fdocsearch/lists"}