chore(fork): restore Typesense package identity

Author: tharropoulos

README.md

@@ -1,132 +1,25 @@
-<div align="center">
+# Typesense DocSearch.js
 
-[![DocSearch](.github/logo.svg)](https://docsearch.algolia.com)
+This is a fork of Algolia's awesome [DocSearch.js](https://github.com/algolia/docsearch) library, customized to send queries to [Typesense](https://typesense.org).
 
-The easiest way to add search to your documentation – for free.
+To be able to use this, you'd first need to setup and run the [Typesense DocSearch Scraper](https://github.com/typesense/typesense-docsearch-scraper).
 
-[![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&url=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)
+#### What is Typesense?
 
-<p align="center">
-  <strong>
-  <a href="https://docsearch.algolia.com">Documentation</a> •
-  <a href="https://codesandbox.io/s/docsearchjs-v3-playground-z9oxj">JavaScript Playground</a> •
-  <a href="https://codesandbox.io/s/docsearch-react-v3-playground-619yg">React Playground</a>
-  </strong>
-</p>
+If you're new to Typesense, it is an **open source** search engine that is simple to use, run and scale, with clean APIs and documentation.
 
-</div>
-
----
-
-DocSearch crawls your documentation, pushes the content to an Algolia index and provides a dropdown search experience on your website.
-
-## Preview
-
-![Ask AI demo](packages/website/static/img/resources/askai_demo.gif)
+Think of it as an open source alternative to Algolia and an easier-to-use, batteries-included alternative to ElasticSearch. Get a quick overview from [this guide](https://typesense.org/guide/).
 
 ## Usage
 
-> Don't have your Algolia credentials yet? [Apply to DocSearch](https://docsearch.algolia.com/apply)!
-
-### JavaScript
-
-#### Installation
-
-```sh
-yarn add @docsearch/js@4
-# or
-npm install @docsearch/js@4
-```
-
-If you don’t want to use a package manager, you can use a standalone endpoint:
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@4"></script>
-```
-
-#### Get started
-
-To 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:
-
-```html
-<div id="docsearch"></div>
-```
-
-Then, 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).
-
-Make 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.
-
-```js app.js
-import docsearch from '@docsearch/js';
-
-import '@docsearch/css';
-
-docsearch({
-  container: '#docsearch',
-  appId: 'YOUR_APP_ID',
-  indexName: 'YOUR_INDEX_NAME',
-  apiKey: 'YOUR_SEARCH_API_KEY',
-});
-```
-
-### React
-
-#### Installation
-
-```bash
-yarn add @docsearch/react@4
-# or
-npm install @docsearch/react@4
-```
-
-If you don’t want to use a package manager, you can use a standalone endpoint:
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@4"></script>
-```
-
-#### Get started
-
-DocSearch generates a fully accessible search box for you.
-
-```jsx App.js
-import { DocSearch } from '@docsearch/react';
-
-import '@docsearch/css';
-
-function App() {
-  return (
-    <DocSearch
-      appId="YOUR_APP_ID"
-      apiKey="YOUR_SEARCH_API_KEY"
-      indices=["YOUR_ALGOLIA_INDEX"]
-    />
-  );
-}
-
-export default App;
-```
-
-## Styling
-
-[Read documentation →](https://docsearch.algolia.com/docs/styling)
-
-## Related projects
-
-DocSearch is made of the following repositories:
-
-- **[algolia/docsearch](https://github.com/algolia/docsearch)**: DocSearch source code.
-- **[algolia/docsearch/packages/website](https://github.com/algolia/docsearch/tree/main/packages/website)**: DocSearch website and documentation.
-- **[algolia/docsearch-configs](https://github.com/algolia/docsearch-configs)**: DocSearch websites configurations that DocSearch powers.
-- **[algolia/docsearch-scraper](https://github.com/algolia/docsearch-scraper)**: DocSearch crawler that extracts data from your documentation.
-
-## Used by
+Read detailed step-by-step instructions on how to configure and setup this version of DocSearch.js on Typesense's dedicated documentation site: https://typesense.org/docs/latest/guide/docsearch.html.
 
-DocSearch 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).
+## Packages
 
-[![Used by](https://api.usedby.dev/npm/@docsearch/js?max=50&sort=stars)](https://github.com/algolia/docsearch/network/dependents)
-Generated with [usedby.dev](https://usedby.dev/)
+- `typesense-docsearch.js`
+- `typesense-docsearch-react`
+- `typesense-docsearch-css`
 
-## License
+## Help
 
-[MIT](LICENSE)
+If you have any questions or run into any problems, please create a Github issue and we'll try our best to help.

adapters/docusaurus-theme-search-algolia/README.md

@@ -1,6 +1,6 @@
-# `@docsearch/docusaurus-adapter`
+# `typesense-docsearch-docusaurus-adapter`
 
-Algolia search component for Docusaurus.
+Typesense DocSearch component for Docusaurus.
 
 ## Usage
 

adapters/docusaurus-theme-search-algolia/package.json

@@ -1,7 +1,7 @@
 {
-  "name": "@docsearch/docusaurus-adapter",
+  "name": "typesense-docsearch-docusaurus-adapter",
   "version": "4.6.0",
-  "description": "Algolia search component for Docusaurus.",
+  "description": "Typesense DocSearch component for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": [
     "*.css"
@@ -22,7 +22,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/algolia/docsearch.git",
+    "url": "https://github.com/typesense/typesense-docsearch.js.git",
     "directory": "adapters/docusaurus-theme-search-algolia"
   },
   "license": "MIT",
@@ -35,7 +35,7 @@
     "copy:watch": "node ./scripts/copy-assets.mjs --watch"
   },
   "dependencies": {
-    "@docsearch/react": "4.6.0",
+    "typesense-docsearch-react": "4.6.0",
     "@docusaurus/core": "^3.9.2",
     "@docusaurus/plugin-content-docs": "^3.9.2",
     "@docusaurus/theme-common": "^3.9.2",

examples/demo-js/package.json

@@ -10,9 +10,9 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@docsearch/css": "4.6.0",
-    "@docsearch/js": "4.6.0",
-    "@docsearch/sidepanel-js": "4.6.0"
+    "typesense-docsearch-css": "4.6.0",
+    "typesense-docsearch.js": "4.6.0",
+    "typesense-docsearch-sidepanel-js": "4.6.0"
   },
   "devDependencies": {
     "vite": "^6.0.7"

examples/demo-react/package.json

@@ -11,11 +11,11 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@docsearch/core": "workspace:*",
-    "@docsearch/css": "workspace:*",
-    "@docsearch/modal": "workspace:*",
-    "@docsearch/react": "workspace:*",
-    "@docsearch/sidepanel": "workspace:*",
+    "typesense-docsearch-core": "workspace:*",
+    "typesense-docsearch-css": "workspace:*",
+    "typesense-docsearch-modal": "workspace:*",
+    "typesense-docsearch-react": "workspace:*",
+    "typesense-docsearch-sidepanel": "workspace:*",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
   },

package.json

@@ -15,7 +15,7 @@
     "cy:run:chrome": "yarn run cy:run --browser chrome",
     "cy:run:edge": "yarn run cy:run --browser edge",
     "cy:run:firefox": "yarn run cy:run --browser firefox",
-    "cy:run": "start-server-and-test 'yarn workspace @docsearch/docusaurus-adapter build && yarn website:test' http://localhost:3000 'cypress run --headless'",
+    "cy:run": "start-server-and-test 'yarn workspace typesense-docsearch-docusaurus-adapter build && yarn website:test' http://localhost:3000 'cypress run --headless'",
     "cy:verify": "cypress verify",
     "lint:css": "stylelint **/src/**/*.css",
     "lint": "eslint .",

packages/docsearch-core/README.md

@@ -1,3 +1,3 @@
-# @docsearch/core
+# typesense-docsearch-core
 
-Core logic and state package for [DocSearch](http://docsearch.algolia.com/), the best search experience for docs.
+Core logic and state package for the Typesense DocSearch fork.

packages/docsearch-core/package.json

@@ -1,13 +1,13 @@
 {
-  "name": "@docsearch/core",
-  "description": "Core package logic for DocSearch",
+  "name": "typesense-docsearch-core",
+  "description": "Core package logic for the Typesense DocSearch fork",
   "version": "4.6.0",
   "license": "MIT",
   "type": "module",
-  "homepage": "https://docsearch.algolia.com",
+  "homepage": "https://typesense.org/docs/latest/guide/docsearch.html",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/algolia/docsearch.git",
+    "url": "git+https://github.com/typesense/typesense-docsearch.js.git",
     "directory": "packages/docsearch-core"
   },
   "author": {

packages/docsearch-css/README.md

@@ -1,27 +1,21 @@
-# @docsearch/css
+# Typesense DocSearch Styles
 
-Style package for [DocSearch](http://docsearch.algolia.com/), the best search experience for docs.
+This is a fork of Algolia's awesome [DocSearch.js](https://github.com/algolia/docsearch) library, customized to send queries to [Typesense](https://typesense.org).
 
-## Installation
+This repo contains styles.
 
-```bash
-yarn add @docsearch/css@4
-# or
-npm install @docsearch/css@4
-```
+To be able to use this, you'd first need to setup and run the [Typesense DocSearch Scraper](https://github.com/typesense/typesense-docsearch-scraper).
 
-If you don’t want to use a package manager, you can use a standalone endpoint:
+#### What is Typesense?
 
-```html
-<script src="https://cdn.jsdelivr.net/npm/@docsearch/css@4"></script>
-```
+If you're new to Typesense, it is an **open source** search engine that is simple to use, run and scale, with clean APIs and documentation.
 
-## Get started
+Think of it as an open source alternative to Algolia and an easier-to-use, batteries-included alternative to ElasticSearch. Get a quick overview from [this guide](https://typesense.org/guide/).
 
-```js
-import '@docsearch/css';
-```
+## Usage
 
-## Documentation
+Read detailed step-by-step instructions on how to configure and setup this version of DocSearch.js on Typesense's dedicated documentation site: https://typesense.org/docs/latest/guide/docsearch.html.
 
-[Read documentation →](https://docsearch.algolia.com/docs/styling)
+## Help
+
+If you have any questions or run into any problems, please create a Github issue and we'll try our best to help.

packages/docsearch-css/package.json

@@ -1,18 +1,20 @@
 {
-  "name": "@docsearch/css",
-  "description": "Styles for DocSearch.",
+  "name": "typesense-docsearch-css",
+  "description": "Styles for DocSearch, customized for Typesense",
   "version": "4.6.0",
   "license": "MIT",
-  "homepage": "https://docsearch.algolia.com",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/algolia/docsearch.git",
-    "directory": "packages/docsearch-css"
-  },
-  "author": {
-    "name": "Algolia, Inc.",
-    "url": "https://www.algolia.com"
-  },
+  "homepage": "https://typesense.org/docs/latest/guide/docsearch.html",
+  "repository": "typesense/docsearch.js",
+  "contributors": [
+    {
+      "name": "Algolia, Inc.",
+      "url": "https://www.algolia.com"
+    },
+    {
+      "name": "Typesense, Inc.",
+      "url": "https://typesense.org"
+    }
+  ],
   "files": [
     "dist/"
   ],