diff --git a/CHANGELOG.md b/CHANGELOG.md index 224b50ce3..abe85ad4f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,13 @@ +# [3.0.0](https://github.com/algolia/docsearch/compare/v3.0.0-alpha.50...v3.0.0) (2022-02-22) + +### Breaking Change + +- **v3:** require appId ([#1299](https://github.com/algolia/docsearch/issues/1299)) ([80630cb](https://github.com/algolia/docsearch/commit/80630cb36dcfe486eff4f7b859deef5431775045)) + +### Bug Fixes + +- **footer:** make SVG accessible ([#1306](https://github.com/algolia/docsearch/issues/1306)) ([59a3ebf](https://github.com/algolia/docsearch/commit/59a3ebf5ecfca951da5139faa08812d450fab1e0)) + # [3.0.0-alpha.50](https://github.com/algolia/docsearch/compare/v3.0.0-alpha.42...v3.0.0-alpha.50) (2022-02-03) ### Bug Fixes diff --git a/README.md b/README.md index 30a980f26..08c6dd57b 100644 --- a/README.md +++ b/README.md @@ -37,15 +37,15 @@ DocSearch crawls your documentation, pushes the content to an Algolia index and #### Installation ```sh -yarn add @docsearch/js@alpha +yarn add @docsearch/js@3 # or -npm install @docsearch/js@alpha +npm install @docsearch/js@3 ``` If you don’t want to use a package manager, you can use a standalone endpoint: ```html - + ``` #### Get started @@ -78,15 +78,15 @@ docsearch({ #### Installation ```bash -yarn add @docsearch/react@alpha +yarn add @docsearch/react@3 # or -npm install @docsearch/react@alpha +npm install @docsearch/react@3 ``` If you don’t want to use a package manager, you can use a standalone endpoint: ```html - + ``` #### Get started diff --git a/examples/demo/package.json b/examples/demo/package.json index cb3dfbf41..c5c321d09 100644 --- a/examples/demo/package.json +++ b/examples/demo/package.json @@ -1,7 +1,7 @@ { "name": "@docsearch/react-example", "description": "DocSearch v3 React example", - "version": "3.0.0-alpha.50", + "version": "3.0.0", "private": true, "license": "MIT", "scripts": { @@ -9,8 +9,8 @@ "start": "parcel index.html" }, "dependencies": { - "@docsearch/css": "3.0.0-alpha.50", - "@docsearch/react": "3.0.0-alpha.50", + "@docsearch/css": "3.0.0", + "@docsearch/react": "3.0.0", "react": "17.0.2", "react-dom": "17.0.2" }, diff --git a/examples/js-demo/package.json b/examples/js-demo/package.json index 947e576b7..6b66dcfda 100644 --- a/examples/js-demo/package.json +++ b/examples/js-demo/package.json @@ -1,7 +1,7 @@ { "name": "@docsearch/js-example", "description": "DocSearch v3 Vanilla JavaScript example", - "version": "3.0.0-alpha.50", + "version": "3.0.0", "private": true, "license": "MIT", "scripts": { @@ -9,8 +9,8 @@ "start": "parcel index.html" }, "dependencies": { - "@docsearch/css": "3.0.0-alpha.50", - "@docsearch/js": "3.0.0-alpha.50" + "@docsearch/css": "3.0.0", + "@docsearch/js": "3.0.0" }, "devDependencies": { "parcel": "2.0.0-beta.2" diff --git a/lerna.json b/lerna.json index 227a58dfc..c8296ca9c 100644 --- a/lerna.json +++ b/lerna.json @@ -1,6 +1,6 @@ { "packages": ["packages/*", "examples/*"], - "version": "3.0.0-alpha.50", + "version": "3.0.0", "npmClient": "yarn", "useWorkspaces": true } diff --git a/packages/docsearch-css/README.md b/packages/docsearch-css/README.md index c72b42e38..f33c75860 100644 --- a/packages/docsearch-css/README.md +++ b/packages/docsearch-css/README.md @@ -5,15 +5,15 @@ Style package for [DocSearch](http://docsearch.algolia.com/), the best search ex ## Installation ```bash -yarn add @docsearch/css@alpha +yarn add @docsearch/css@3 # or -npm install @docsearch/css@alpha +npm install @docsearch/css@3 ``` If you don’t want to use a package manager, you can use a standalone endpoint: ```html - + ``` ## Get started diff --git a/packages/docsearch-css/package.json b/packages/docsearch-css/package.json index c388488ab..79295bafe 100644 --- a/packages/docsearch-css/package.json +++ b/packages/docsearch-css/package.json @@ -1,7 +1,7 @@ { "name": "@docsearch/css", "description": "Styles for DocSearch.", - "version": "3.0.0-alpha.50", + "version": "3.0.0", "license": "MIT", "homepage": "https://docsearch.algolia.com", "repository": "algolia/docsearch", diff --git a/packages/docsearch-js/README.md b/packages/docsearch-js/README.md index 147933fd8..e1f04cc2a 100644 --- a/packages/docsearch-js/README.md +++ b/packages/docsearch-js/README.md @@ -5,9 +5,9 @@ JavaScript package for [DocSearch](http://docsearch.algolia.com/), the best sear ## Installation ```sh -yarn add @docsearch/js@alpha +yarn add @docsearch/js@3 # or -npm install @docsearch/js@alpha +npm install @docsearch/js@3 ``` ## Get started @@ -15,7 +15,7 @@ npm install @docsearch/js@alpha If you don’t want to use a package manager, you can use a standalone endpoint: ```html - + ``` 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: diff --git a/packages/docsearch-js/package.json b/packages/docsearch-js/package.json index f9be5a826..dc04cf570 100644 --- a/packages/docsearch-js/package.json +++ b/packages/docsearch-js/package.json @@ -1,7 +1,7 @@ { "name": "@docsearch/js", "description": "JavaScript package for DocSearch, the best search experience for docs.", - "version": "3.0.0-alpha.50", + "version": "3.0.0", "license": "MIT", "homepage": "https://docsearch.algolia.com", "repository": "algolia/docsearch", @@ -31,7 +31,7 @@ "watch": "watch \"yarn on:change\" --ignoreDirectoryPattern \"/dist/\"" }, "dependencies": { - "@docsearch/react": "3.0.0-alpha.50", + "@docsearch/react": "3.0.0", "preact": "^10.0.0" } } diff --git a/packages/docsearch-react/README.md b/packages/docsearch-react/README.md index 3725f78e8..b13eb61a2 100644 --- a/packages/docsearch-react/README.md +++ b/packages/docsearch-react/README.md @@ -5,15 +5,15 @@ React package for [DocSearch](http://docsearch.algolia.com/), the best search ex ## Installation ```bash -yarn add @docsearch/react@alpha +yarn add @docsearch/react@3 # or -npm install @docsearch/react@alpha +npm install @docsearch/react@3 ``` If you don’t want to use a package manager, you can use a standalone endpoint: ```html - + ``` ## Get started diff --git a/packages/docsearch-react/package.json b/packages/docsearch-react/package.json index 7a6c28ca7..810facb91 100644 --- a/packages/docsearch-react/package.json +++ b/packages/docsearch-react/package.json @@ -1,7 +1,7 @@ { "name": "@docsearch/react", "description": "React package for DocSearch, the best search experience for docs.", - "version": "3.0.0-alpha.50", + "version": "3.0.0", "license": "MIT", "homepage": "https://docsearch.algolia.com", "repository": "algolia/docsearch", @@ -36,7 +36,7 @@ "dependencies": { "@algolia/autocomplete-core": "1.5.2", "@algolia/autocomplete-preset-algolia": "1.5.2", - "@docsearch/css": "3.0.0-alpha.50", + "@docsearch/css": "3.0.0", "algoliasearch": "^4.0.0" }, "peerDependencies": { diff --git a/packages/docsearch-react/src/version.ts b/packages/docsearch-react/src/version.ts index 1e28aad8d..83bbd6457 100644 --- a/packages/docsearch-react/src/version.ts +++ b/packages/docsearch-react/src/version.ts @@ -1 +1 @@ -export const version = '3.0.0-alpha.50'; +export const version = '3.0.0'; diff --git a/packages/website/docs/DocSearch-v3.mdx b/packages/website/docs/DocSearch-v3.mdx index 41de7153b..430c65d16 100644 --- a/packages/website/docs/DocSearch-v3.mdx +++ b/packages/website/docs/DocSearch-v3.mdx @@ -38,9 +38,9 @@ DocSearch packages are available on the [npm][10] registry. ```bash -yarn add @docsearch/js@alpha +yarn add @docsearch/js@3 # or -npm install @docsearch/js@alpha +npm install @docsearch/js@3 ``` ### Without package manager @@ -48,25 +48,22 @@ npm install @docsearch/js@alpha If you don't want to use a package manger, you can add the CSS to the `` of your website: ```html - + ``` And the JavaScript at the end of your ``: ```html - + ``` ```bash -yarn add @docsearch/react@alpha +yarn add @docsearch/react@3 # or -npm install @docsearch/react@alpha +npm install @docsearch/react@3 ``` ### Without package manager @@ -74,16 +71,13 @@ npm install @docsearch/react@alpha If you don't want to use a package manger, you can add the CSS to the `` of your website: ```html - + ``` And the JavaScript at the end of your ``: ```html - + ``` diff --git a/packages/website/docs/styling.md b/packages/website/docs/styling.md index 7432603e3..3d33e2c43 100644 --- a/packages/website/docs/styling.md +++ b/packages/website/docs/styling.md @@ -27,18 +27,15 @@ This package is a dependency of [`@docsearch/js`][1] and [`@docsearch/react`][1] ## Installation ```bash -yarn add @docsearch/css@alpha +yarn add @docsearch/css@3 # or -npm install @docsearch/css@alpha +npm install @docsearch/css@3 ``` If you don’t want to use a package manager, you can use a standalone endpoint: ```html - + ``` ## Files diff --git a/packages/website/package.json b/packages/website/package.json index 70c03c21e..cc44ae067 100644 --- a/packages/website/package.json +++ b/packages/website/package.json @@ -1,6 +1,6 @@ { "name": "@docsearch/website", - "version": "3.0.0-alpha.50", + "version": "3.0.0", "private": true, "homepage": "https://docsearch.algolia.com/", "scripts": { @@ -17,7 +17,7 @@ }, "dependencies": { "@algolia/ui-library": "4.0.0-beta.71", - "@docsearch/react": "3.0.0-alpha.50", + "@docsearch/react": "3.0.0", "@docusaurus/core": "2.0.0-beta.15", "@docusaurus/preset-classic": "2.0.0-beta.15", "@mdx-js/react": "1.6.22",