chore: release v3.0.0 (#1311)
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
This commit is contained in:
InstantSearch
GitHub
parent
59a3ebf5ec
commit
6c14758b56
15 changed files with 51 additions and 50 deletions
10
CHANGELOG.md
10
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
|
||||
|
|
|
|||
12
README.md
12
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
|
||||
<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@alpha"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3"></script>
|
||||
```
|
||||
|
||||
#### 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
|
||||
<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@alpha"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@3"></script>
|
||||
```
|
||||
|
||||
#### Get started
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
},
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"packages": ["packages/*", "examples/*"],
|
||||
"version": "3.0.0-alpha.50",
|
||||
"version": "3.0.0",
|
||||
"npmClient": "yarn",
|
||||
"useWorkspaces": true
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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
|
||||
<script src="https://cdn.jsdelivr.net/npm/@docsearch/css@alpha"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/@docsearch/css@3"></script>
|
||||
```
|
||||
|
||||
## Get started
|
||||
|
|
|
|||
|
|
@ -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",
|
||||
|
|
|
|||
|
|
@ -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
|
||||
<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@alpha"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3"></script>
|
||||
```
|
||||
|
||||
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:
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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
|
||||
<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@alpha"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@3"></script>
|
||||
```
|
||||
|
||||
## Get started
|
||||
|
|
|
|||
|
|
@ -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": {
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
export const version = '3.0.0-alpha.50';
|
||||
export const version = '3.0.0';
|
||||
|
|
|
|||
|
|
@ -38,9 +38,9 @@ DocSearch packages are available on the [npm][10] registry.
|
|||
<TabItem value="js">
|
||||
|
||||
```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 `<head>` of your website:
|
||||
|
||||
```html
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://cdn.jsdelivr.net/npm/@docsearch/css@alpha"
|
||||
/>
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3" />
|
||||
```
|
||||
|
||||
And the JavaScript at the end of your `<body>`:
|
||||
|
||||
```html
|
||||
<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@alpha"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3"></script>
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="react">
|
||||
|
||||
```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 `<head>` of your website:
|
||||
|
||||
```html
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://cdn.jsdelivr.net/npm/@docsearch/css@alpha"
|
||||
/>
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3" />
|
||||
```
|
||||
|
||||
And the JavaScript at the end of your `<body>`:
|
||||
|
||||
```html
|
||||
<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@alpha"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@3"></script>
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
|
|
|||
|
|
@ -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
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://cdn.jsdelivr.net/npm/@docsearch/css@alpha"
|
||||
/>
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3" />
|
||||
```
|
||||
|
||||
## Files
|
||||
|
|
|
|||
|
|
@ -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",
|
||||
|
|
|
|||
Loading…
Reference in a new issue