Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/lint-autofix.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ jobs:
- name: AutoFix Spelling
run: yarn lint:spelling:fix

- name: Print Diff
run: git diff

- uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: 'refactor: apply lint autofix'
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
"lint:js": "eslint --cache --report-unused-disable-directives \"**/*.{js,jsx,ts,tsx,mjs}\"",
"lint:js:fix": "yarn lint:js --fix",
"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:fix": "yarn lint:style --fix",
"lerna": "lerna",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ declare module '@docusaurus/theme-search-algolia' {
from: string;
to: string;
};
insights?: boolean;
};
};
export type UserThemeConfig = DeepPartial<ThemeConfig>;
Expand Down
11 changes: 6 additions & 5 deletions project-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,11 @@ Datagit
datagit
Datagit's
dedup
Déja
devto
dingers
Dmitry
Docsearch
docsearch
Docsify
Docu
Expand All @@ -83,7 +85,6 @@ dogfooding
Dojocat
Dyte
dyte
Déja
easyops
Endi
endi
Expand Down Expand Up @@ -118,14 +119,14 @@ Hamel
Hasura
hasura
Heavener
Héctor
héllô
Hideable
hideable
hola
Hostman
hoverable
Husain
Héctor
héllô
IANAD
idempotency
Iframes
Expand Down Expand Up @@ -220,6 +221,7 @@ noninteractive
npmjs
nprogress
Nuxt
ödingers
opensearch
opensearchdescription
opensource
Expand Down Expand Up @@ -305,6 +307,7 @@ saurus
Scaleway
Sebastien
sebastien
Sébastien
sebastienlorber
sensical
setaf
Expand Down Expand Up @@ -350,7 +353,6 @@ supabase
SVGR
svgr
swizzlable
Sébastien
Teik
templating
Thanos
Expand Down Expand Up @@ -408,4 +410,3 @@ yangshunz
Zhou
zoomable
zpao
ödingers
3 changes: 3 additions & 0 deletions website/docs/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ export default {
// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search',

// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
insights: false,

//... other Algolia params
},
// highlight-end
Expand Down
3 changes: 3 additions & 0 deletions website/versioned_docs/version-2.x/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ module.exports = {
// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search',

// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
insights: false,

//... other Algolia params
},
// highlight-end
Expand Down
3 changes: 3 additions & 0 deletions website/versioned_docs/version-3.0.1/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ export default {
// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search',

// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
insights: false,

//... other Algolia params
},
// highlight-end
Expand Down
3 changes: 3 additions & 0 deletions website/versioned_docs/version-3.1.1/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ export default {
// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search',

// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
insights: false,

//... other Algolia params
},
// highlight-end
Expand Down
3 changes: 3 additions & 0 deletions website/versioned_docs/version-3.2.1/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ export default {
// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search',

// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
insights: false,

//... other Algolia params
},
// highlight-end
Expand Down
Loading