docs: update docusaurus to v3 (#5625)

* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions

View File

@@ -8,13 +8,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Implements
- [`ISearchService`](../interfaces/ISearchService.mdx)
- [ISearchService](../interfaces/ISearchService.mdx)
## Constructors
### constructor
`Protected` **new AbstractSearchService**(`container`, `options`)
`Protected **new AbstractSearchService**(container, options)`
#### Parameters
@@ -53,7 +53,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "options_",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -66,16 +66,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### options
`get` **options**(): Record<`string`, `unknown`\>
`get**options**(): Record&#60;string, unknown&#62;`
#### Returns
Record<`string`, `unknown`\>
`Record<string, unknown>`
<ParameterTypes parameters={[
{
"name": "Record",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"optional": false,
"defaultValue": "",
"description": "",
@@ -88,7 +88,7 @@ Record<`string`, `unknown`\>
### addDocuments
`Abstract` **addDocuments**(`indexName`, `documents`, `type`): `unknown`
`Abstract **addDocuments**(indexName, documents, type): unknown`
Used to index documents by the search engine provider
@@ -144,7 +144,7 @@ ___
### createIndex
`Abstract` **createIndex**(`indexName`, `options`): `unknown`
`Abstract **createIndex**(indexName, options): unknown`
Used to create an index
@@ -191,7 +191,7 @@ ___
### deleteAllDocuments
`Abstract` **deleteAllDocuments**(`indexName`): `unknown`
`Abstract **deleteAllDocuments**(indexName): unknown`
Used to delete all documents
@@ -229,7 +229,7 @@ ___
### deleteDocument
`Abstract` **deleteDocument**(`indexName`, `document_id`): `unknown`
`Abstract **deleteDocument**(indexName, document_id): unknown`
Used to delete document
@@ -276,7 +276,7 @@ ___
### getIndex
`Abstract` **getIndex**(`indexName`): `unknown`
`Abstract **getIndex**(indexName): unknown`
Used to get an index
@@ -314,7 +314,7 @@ ___
### replaceDocuments
`Abstract` **replaceDocuments**(`indexName`, `documents`, `type`): `unknown`
`Abstract **replaceDocuments**(indexName, documents, type): unknown`
Used to replace documents
@@ -370,7 +370,7 @@ ___
### search
`Abstract` **search**(`indexName`, `query`, `options`): `unknown`
`Abstract **search**(indexName, query, options): unknown`
Used to search for a document in an index
@@ -426,7 +426,7 @@ ___
### updateSettings
`Abstract` **updateSettings**(`indexName`, `settings`): `unknown`
`Abstract **updateSettings**(indexName, settings): unknown`
Used to update the settings of an index