fix(algolia): add insights property on Algolia Theme Config object TS definition (#10048)

Co-authored-by: sebastien <lorber.sebastien@gmail.com>
This commit is contained in:
Virgil993 2024-04-18 17:00:24 +03:00 committed by GitHub
parent 01ffcd96a0
commit 8e084ef8ba
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 26 additions and 6 deletions

View file

@ -39,6 +39,9 @@ jobs:
- name: AutoFix Spelling - name: AutoFix Spelling
run: yarn lint:spelling:fix run: yarn lint:spelling:fix
- name: Print Diff
run: git diff
- uses: stefanzweifel/git-auto-commit-action@v5 - uses: stefanzweifel/git-auto-commit-action@v5
with: with:
commit_message: 'refactor: apply lint autofix' commit_message: 'refactor: apply lint autofix'

View file

@ -53,7 +53,7 @@
"lint:js": "eslint --cache --report-unused-disable-directives \"**/*.{js,jsx,ts,tsx,mjs}\"", "lint:js": "eslint --cache --report-unused-disable-directives \"**/*.{js,jsx,ts,tsx,mjs}\"",
"lint:js:fix": "yarn lint:js --fix", "lint:js:fix": "yarn lint:js --fix",
"lint:spelling": "cspell \"**\" --no-progress --show-context --show-suggestions", "lint:spelling": "cspell \"**\" --no-progress --show-context --show-suggestions",
"lint:spelling:fix": "yarn rimraf project-words.txt && echo \"# Project Words - DO NOT TOUCH - This is updated through CI\" >> project-words.txt && yarn -s lint:spelling --words-only --unique --no-exit-code --no-summary \"**\" | sort --ignore-case >> project-words.txt", "lint:spelling:fix": "yarn rimraf project-words.txt && echo \"# Project Words - DO NOT TOUCH - This is updated through CI\" >> project-words.txt && yarn -s lint:spelling --words-only --unique --no-exit-code --no-summary \"**\" | cross-env LC_ALL=en_US.UTF-8 sort --ignore-case >> project-words.txt",
"lint:style": "stylelint \"**/*.css\"", "lint:style": "stylelint \"**/*.css\"",
"lint:style:fix": "yarn lint:style --fix", "lint:style:fix": "yarn lint:style --fix",
"lerna": "lerna", "lerna": "lerna",

View file

@ -21,6 +21,7 @@ declare module '@docusaurus/theme-search-algolia' {
from: string; from: string;
to: string; to: string;
}; };
insights?: boolean;
}; };
}; };
export type UserThemeConfig = DeepPartial<ThemeConfig>; export type UserThemeConfig = DeepPartial<ThemeConfig>;

View file

@ -67,9 +67,11 @@ Datagit
datagit datagit
Datagit's Datagit's
dedup dedup
Déja
devto devto
dingers dingers
Dmitry Dmitry
Docsearch
docsearch docsearch
Docsify Docsify
Docu Docu
@ -83,7 +85,6 @@ dogfooding
Dojocat Dojocat
Dyte Dyte
dyte dyte
Déja
easyops easyops
Endi Endi
endi endi
@ -118,14 +119,14 @@ Hamel
Hasura Hasura
hasura hasura
Heavener Heavener
Héctor
héllô
Hideable Hideable
hideable hideable
hola hola
Hostman Hostman
hoverable hoverable
Husain Husain
Héctor
héllô
IANAD IANAD
idempotency idempotency
Iframes Iframes
@ -220,6 +221,7 @@ noninteractive
npmjs npmjs
nprogress nprogress
Nuxt Nuxt
ödingers
opensearch opensearch
opensearchdescription opensearchdescription
opensource opensource
@ -305,6 +307,7 @@ saurus
Scaleway Scaleway
Sebastien Sebastien
sebastien sebastien
Sébastien
sebastienlorber sebastienlorber
sensical sensical
setaf setaf
@ -350,7 +353,6 @@ supabase
SVGR SVGR
svgr svgr
swizzlable swizzlable
Sébastien
Teik Teik
templating templating
Thanos Thanos
@ -408,4 +410,3 @@ yangshunz
Zhou Zhou
zoomable zoomable
zpao zpao
ödingers

View file

@ -124,6 +124,9 @@ export default {
// Optional: path for search page that enabled by default (`false` to disable it) // Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search', searchPagePath: 'search',
// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
insights: false,
//... other Algolia params //... other Algolia params
}, },
// highlight-end // highlight-end

View file

@ -116,6 +116,9 @@ module.exports = {
// Optional: path for search page that enabled by default (`false` to disable it) // Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search', searchPagePath: 'search',
// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
insights: false,
//... other Algolia params //... other Algolia params
}, },
// highlight-end // highlight-end

View file

@ -116,6 +116,9 @@ export default {
// Optional: path for search page that enabled by default (`false` to disable it) // Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search', searchPagePath: 'search',
// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
insights: false,
//... other Algolia params //... other Algolia params
}, },
// highlight-end // highlight-end

View file

@ -116,6 +116,9 @@ export default {
// Optional: path for search page that enabled by default (`false` to disable it) // Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search', searchPagePath: 'search',
// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
insights: false,
//... other Algolia params //... other Algolia params
}, },
// highlight-end // highlight-end

View file

@ -124,6 +124,9 @@ export default {
// Optional: path for search page that enabled by default (`false` to disable it) // Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search', searchPagePath: 'search',
// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
insights: false,
//... other Algolia params //... other Algolia params
}, },
// highlight-end // highlight-end