@docusaurus/theme-common 3.5.0 → 3.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.d.ts +4 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +10 -0
- package/lib/index.js.map +1 -1
- package/lib/translations/blogTranslations.js +1 -1
- package/package.json +8 -8
- package/src/index.ts +11 -0
- package/src/translations/blogTranslations.tsx +1 -1
package/lib/index.d.ts
CHANGED
|
@@ -7,6 +7,10 @@
|
|
|
7
7
|
export declare function useCurrentSidebarCategory(...args: unknown[]): unknown;
|
|
8
8
|
export declare function filterDocCardListItems(...args: unknown[]): unknown;
|
|
9
9
|
export declare function useDocsPreferredVersion(...args: unknown[]): unknown;
|
|
10
|
+
export declare function useContextualSearchFilters(): {
|
|
11
|
+
locale: string;
|
|
12
|
+
tags: any[];
|
|
13
|
+
};
|
|
10
14
|
export { useThemeConfig, type ThemeConfig, type UserThemeConfig, type Navbar, type NavbarItem, type NavbarLogo, type MultiColumnFooter, type SimpleFooter, type Footer, type FooterLogo, type FooterLinkItem, type ColorModeConfig, } from './utils/useThemeConfig';
|
|
11
15
|
export { default as ThemedComponent } from './components/ThemedComponent';
|
|
12
16
|
export { createStorageSlot, useStorageSlot, listStorageKeys, } from './utils/storageUtils';
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AASH,wBAAgB,yBAAyB,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAKrE;AACD,wBAAgB,sBAAsB,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAKlE;AACD,wBAAgB,uBAAuB,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAKnE;AACD,wBAAgB,0BAA0B;;;EAOzC;AAMD,OAAO,EACL,cAAc,EACd,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,eAAe,GACrB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAExE,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAC,oBAAoB,EAAC,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EACL,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,YAAY,EAAE,qBAAqB,EAAC,MAAM,uBAAuB,CAAC;AAE1E,OAAO,EAAC,YAAY,EAAE,KAAK,SAAS,EAAC,MAAM,sBAAsB,CAAC;AAElE,OAAO,EACL,yBAAyB,EACzB,KAAK,4BAA4B,GAClC,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAOpD,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,KAAK,cAAc,GACpB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAC,UAAU,EAAE,IAAI,EAAE,OAAO,EAAC,MAAM,iBAAiB,CAAC;AAE1D,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,sBAAsB,EAAC,MAAM,yBAAyB,CAAC;AAE/D,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,GACnB,MAAM,8CAA8C,CAAC;AAEtD,OAAO,EACL,2BAA2B,EAC3B,kBAAkB,EAClB,iCAAiC,EACjC,kBAAkB,GACnB,MAAM,4BAA4B,CAAC"}
|
package/lib/index.js
CHANGED
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
* This source code is licensed under the MIT license found in the
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
|
+
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
|
8
|
+
import { DEFAULT_SEARCH_TAG } from './utils/searchUtils';
|
|
7
9
|
// TODO Docusaurus v4: remove these workarounds as a breaking change
|
|
8
10
|
// and remove docs plugin peerDeps in theme-common/package.json
|
|
9
11
|
// This is public API surface that we need to keep for v3
|
|
@@ -20,6 +22,14 @@ export function useDocsPreferredVersion(...args) {
|
|
|
20
22
|
// eslint-disable-next-line @typescript-eslint/no-var-requires
|
|
21
23
|
return require('@docusaurus/plugin-content-docs/client').useDocsPreferredVersion(...args);
|
|
22
24
|
}
|
|
25
|
+
export function useContextualSearchFilters() {
|
|
26
|
+
const { i18n } = useDocusaurusContext();
|
|
27
|
+
const docsTags =
|
|
28
|
+
// eslint-disable-next-line @typescript-eslint/no-var-requires
|
|
29
|
+
require('@docusaurus/plugin-content-docs/client').useDocsContextualSearchTags();
|
|
30
|
+
const tags = [DEFAULT_SEARCH_TAG, ...docsTags];
|
|
31
|
+
return { locale: i18n.currentLocale, tags };
|
|
32
|
+
}
|
|
23
33
|
/*
|
|
24
34
|
* APIs to document
|
|
25
35
|
*/
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,oEAAoE;AACpE,gEAAgE;AAChE,0DAA0D;AAC1D,yDAAyD;AACzD,MAAM,UAAU,yBAAyB,CAAC,GAAG,IAAe;IAC1D,8DAA8D;IAC9D,OAAO,OAAO,CAAC,wCAAwC,CAAC,CAAC,yBAAyB,CAChF,GAAG,IAAI,CACR,CAAC;AACJ,CAAC;AACD,MAAM,UAAU,sBAAsB,CAAC,GAAG,IAAe;IACvD,8DAA8D;IAC9D,OAAO,OAAO,CAAC,wCAAwC,CAAC,CAAC,sBAAsB,CAC7E,GAAG,IAAI,CACR,CAAC;AACJ,CAAC;AACD,MAAM,UAAU,uBAAuB,CAAC,GAAG,IAAe;IACxD,8DAA8D;IAC9D,OAAO,OAAO,CAAC,wCAAwC,CAAC,CAAC,uBAAuB,CAC9E,GAAG,IAAI,CACR,CAAC;AACJ,CAAC;AAED;;GAEG;AAEH,OAAO,EACL,cAAc,GAYf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAExE,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAC,oBAAoB,EAAC,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EACL,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,YAAY,EAAE,qBAAqB,EAAC,MAAM,uBAAuB,CAAC;AAE1E,OAAO,EAAC,YAAY,EAAiB,MAAM,sBAAsB,CAAC;AAElE,OAAO,EACL,yBAAyB,GAE1B,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD;;;GAGG;AAEH,OAAO,EACL,sBAAsB,EACtB,iBAAiB,GAElB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAC,UAAU,EAAE,IAAI,EAAE,OAAO,EAAC,MAAM,iBAAiB,CAAC;AAE1D,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,sBAAsB,EAAC,MAAM,yBAAyB,CAAC;AAE/D,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,GACnB,MAAM,8CAA8C,CAAC;AAEtD,OAAO,EACL,2BAA2B,EAC3B,kBAAkB,EAClB,iCAAiC,EACjC,kBAAkB,GACnB,MAAM,4BAA4B,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAC,kBAAkB,EAAC,MAAM,qBAAqB,CAAC;AAEvD,oEAAoE;AACpE,gEAAgE;AAChE,0DAA0D;AAC1D,yDAAyD;AACzD,MAAM,UAAU,yBAAyB,CAAC,GAAG,IAAe;IAC1D,8DAA8D;IAC9D,OAAO,OAAO,CAAC,wCAAwC,CAAC,CAAC,yBAAyB,CAChF,GAAG,IAAI,CACR,CAAC;AACJ,CAAC;AACD,MAAM,UAAU,sBAAsB,CAAC,GAAG,IAAe;IACvD,8DAA8D;IAC9D,OAAO,OAAO,CAAC,wCAAwC,CAAC,CAAC,sBAAsB,CAC7E,GAAG,IAAI,CACR,CAAC;AACJ,CAAC;AACD,MAAM,UAAU,uBAAuB,CAAC,GAAG,IAAe;IACxD,8DAA8D;IAC9D,OAAO,OAAO,CAAC,wCAAwC,CAAC,CAAC,uBAAuB,CAC9E,GAAG,IAAI,CACR,CAAC;AACJ,CAAC;AACD,MAAM,UAAU,0BAA0B;IACxC,MAAM,EAAC,IAAI,EAAC,GAAG,oBAAoB,EAAE,CAAC;IACtC,MAAM,QAAQ;IACZ,8DAA8D;IAC9D,OAAO,CAAC,wCAAwC,CAAC,CAAC,2BAA2B,EAAE,CAAC;IAClF,MAAM,IAAI,GAAG,CAAC,kBAAkB,EAAE,GAAG,QAAQ,CAAC,CAAC;IAC/C,OAAO,EAAC,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,EAAC,CAAC;AAC5C,CAAC;AAED;;GAEG;AAEH,OAAO,EACL,cAAc,GAYf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAExE,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAC,oBAAoB,EAAC,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EACL,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,YAAY,EAAE,qBAAqB,EAAC,MAAM,uBAAuB,CAAC;AAE1E,OAAO,EAAC,YAAY,EAAiB,MAAM,sBAAsB,CAAC;AAElE,OAAO,EACL,yBAAyB,GAE1B,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD;;;GAGG;AAEH,OAAO,EACL,sBAAsB,EACtB,iBAAiB,GAElB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAC,UAAU,EAAE,IAAI,EAAE,OAAO,EAAC,MAAM,iBAAiB,CAAC;AAE1D,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,sBAAsB,EAAC,MAAM,yBAAyB,CAAC;AAE/D,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,GACnB,MAAM,8CAA8C,CAAC;AAEtD,OAAO,EACL,2BAA2B,EAC3B,kBAAkB,EAClB,iCAAiC,EACjC,kBAAkB,GACnB,MAAM,4BAA4B,CAAC"}
|
|
@@ -42,7 +42,7 @@ export const translateBlogAuthorsListPageTitle = () => translate({
|
|
|
42
42
|
});
|
|
43
43
|
export function BlogAuthorsListViewAllLabel() {
|
|
44
44
|
return (<Translate id="theme.blog.authorsList.viewAll" description="The label of the link targeting the blog authors page">
|
|
45
|
-
View
|
|
45
|
+
View all authors
|
|
46
46
|
</Translate>);
|
|
47
47
|
}
|
|
48
48
|
//# sourceMappingURL=blogTranslations.js.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/theme-common",
|
|
3
|
-
"version": "3.5.
|
|
3
|
+
"version": "3.5.2",
|
|
4
4
|
"description": "Common code for Docusaurus themes.",
|
|
5
5
|
"main": "./lib/index.js",
|
|
6
6
|
"types": "./lib/index.d.ts",
|
|
@@ -30,10 +30,10 @@
|
|
|
30
30
|
},
|
|
31
31
|
"license": "MIT",
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@docusaurus/mdx-loader": "3.5.
|
|
34
|
-
"@docusaurus/module-type-aliases": "3.5.
|
|
35
|
-
"@docusaurus/utils": "3.5.
|
|
36
|
-
"@docusaurus/utils-common": "3.5.
|
|
33
|
+
"@docusaurus/mdx-loader": "3.5.2",
|
|
34
|
+
"@docusaurus/module-type-aliases": "3.5.2",
|
|
35
|
+
"@docusaurus/utils": "3.5.2",
|
|
36
|
+
"@docusaurus/utils-common": "3.5.2",
|
|
37
37
|
"@types/history": "^4.7.11",
|
|
38
38
|
"@types/react": "*",
|
|
39
39
|
"@types/react-router-config": "*",
|
|
@@ -44,8 +44,8 @@
|
|
|
44
44
|
"utility-types": "^3.10.0"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
|
-
"@docusaurus/core": "3.5.
|
|
48
|
-
"@docusaurus/types": "3.5.
|
|
47
|
+
"@docusaurus/core": "3.5.2",
|
|
48
|
+
"@docusaurus/types": "3.5.2",
|
|
49
49
|
"fs-extra": "^11.1.1",
|
|
50
50
|
"lodash": "^4.17.21",
|
|
51
51
|
"schema-dts": "^1.1.2"
|
|
@@ -58,5 +58,5 @@
|
|
|
58
58
|
"engines": {
|
|
59
59
|
"node": ">=18.0"
|
|
60
60
|
},
|
|
61
|
-
"gitHead": "
|
|
61
|
+
"gitHead": "eeec303dd773774ed5a023884800da0b061f6942"
|
|
62
62
|
}
|
package/src/index.ts
CHANGED
|
@@ -5,6 +5,9 @@
|
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
|
+
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
|
9
|
+
import {DEFAULT_SEARCH_TAG} from './utils/searchUtils';
|
|
10
|
+
|
|
8
11
|
// TODO Docusaurus v4: remove these workarounds as a breaking change
|
|
9
12
|
// and remove docs plugin peerDeps in theme-common/package.json
|
|
10
13
|
// This is public API surface that we need to keep for v3
|
|
@@ -27,6 +30,14 @@ export function useDocsPreferredVersion(...args: unknown[]): unknown {
|
|
|
27
30
|
...args,
|
|
28
31
|
);
|
|
29
32
|
}
|
|
33
|
+
export function useContextualSearchFilters() {
|
|
34
|
+
const {i18n} = useDocusaurusContext();
|
|
35
|
+
const docsTags =
|
|
36
|
+
// eslint-disable-next-line @typescript-eslint/no-var-requires
|
|
37
|
+
require('@docusaurus/plugin-content-docs/client').useDocsContextualSearchTags();
|
|
38
|
+
const tags = [DEFAULT_SEARCH_TAG, ...docsTags];
|
|
39
|
+
return {locale: i18n.currentLocale, tags};
|
|
40
|
+
}
|
|
30
41
|
|
|
31
42
|
/*
|
|
32
43
|
* APIs to document
|