@docusaurus/plugin-content-docs 0.0.0-4817 → 0.0.0-4818
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.js +1 -1
- package/lib/sidebars/types.d.ts +3 -3
- package/package.json +9 -9
- package/src/index.ts +1 -1
- package/src/plugin-content-docs.d.ts +2 -2
- package/src/sidebars/types.ts +8 -11
package/lib/index.js
CHANGED
package/lib/sidebars/types.d.ts
CHANGED
|
@@ -158,14 +158,14 @@ export declare type SidebarItemsGeneratorArgs = {
|
|
|
158
158
|
};
|
|
159
159
|
};
|
|
160
160
|
export declare type SidebarItemsGenerator = (generatorArgs: SidebarItemsGeneratorArgs) => Promise<NormalizedSidebar>;
|
|
161
|
-
export declare type
|
|
161
|
+
export declare type SidebarItemsGeneratorOption = (generatorArgs: {
|
|
162
162
|
/**
|
|
163
163
|
* Useful to re-use/enhance the default sidebar generation logic from
|
|
164
164
|
* Docusaurus.
|
|
165
|
+
* @see https://github.com/facebook/docusaurus/issues/4640#issuecomment-822292320
|
|
165
166
|
*/
|
|
166
167
|
defaultSidebarItemsGenerator: SidebarItemsGenerator;
|
|
167
|
-
} & SidebarItemsGeneratorArgs
|
|
168
|
-
export declare type SidebarItemsGeneratorOption = (generatorArgs: SidebarItemsGeneratorOptionArgs) => Promise<NormalizedSidebarItem[]>;
|
|
168
|
+
} & SidebarItemsGeneratorArgs) => Promise<NormalizedSidebarItem[]>;
|
|
169
169
|
export declare type SidebarProcessorParams = {
|
|
170
170
|
sidebarItemsGenerator: SidebarItemsGeneratorOption;
|
|
171
171
|
numberPrefixParser: NumberPrefixParser;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/plugin-content-docs",
|
|
3
|
-
"version": "0.0.0-
|
|
3
|
+
"version": "0.0.0-4818",
|
|
4
4
|
"description": "Docs plugin for Docusaurus.",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"exports": {
|
|
@@ -23,11 +23,11 @@
|
|
|
23
23
|
},
|
|
24
24
|
"license": "MIT",
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@docusaurus/core": "0.0.0-
|
|
27
|
-
"@docusaurus/logger": "0.0.0-
|
|
28
|
-
"@docusaurus/mdx-loader": "0.0.0-
|
|
29
|
-
"@docusaurus/utils": "0.0.0-
|
|
30
|
-
"@docusaurus/utils-validation": "0.0.0-
|
|
26
|
+
"@docusaurus/core": "0.0.0-4818",
|
|
27
|
+
"@docusaurus/logger": "0.0.0-4818",
|
|
28
|
+
"@docusaurus/mdx-loader": "0.0.0-4818",
|
|
29
|
+
"@docusaurus/utils": "0.0.0-4818",
|
|
30
|
+
"@docusaurus/utils-validation": "0.0.0-4818",
|
|
31
31
|
"combine-promises": "^1.1.0",
|
|
32
32
|
"fs-extra": "^10.0.1",
|
|
33
33
|
"import-fresh": "^3.3.0",
|
|
@@ -39,8 +39,8 @@
|
|
|
39
39
|
"webpack": "^5.70.0"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
|
-
"@docusaurus/module-type-aliases": "0.0.0-
|
|
43
|
-
"@docusaurus/types": "0.0.0-
|
|
42
|
+
"@docusaurus/module-type-aliases": "0.0.0-4818",
|
|
43
|
+
"@docusaurus/types": "0.0.0-4818",
|
|
44
44
|
"@types/js-yaml": "^4.0.5",
|
|
45
45
|
"@types/picomatch": "^2.3.0",
|
|
46
46
|
"commander": "^5.1.0",
|
|
@@ -56,5 +56,5 @@
|
|
|
56
56
|
"engines": {
|
|
57
57
|
"node": ">=14"
|
|
58
58
|
},
|
|
59
|
-
"gitHead": "
|
|
59
|
+
"gitHead": "0ea48452c51db14e48c6395071903307663e2281"
|
|
60
60
|
}
|
package/src/index.ts
CHANGED
|
@@ -10,9 +10,9 @@ declare module '@docusaurus/plugin-content-docs' {
|
|
|
10
10
|
import type {ContentPaths, Tag, FrontMatterTag} from '@docusaurus/utils';
|
|
11
11
|
import type {Required} from 'utility-types';
|
|
12
12
|
|
|
13
|
-
export
|
|
13
|
+
export type Assets = {
|
|
14
14
|
image?: string;
|
|
15
|
-
}
|
|
15
|
+
};
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
18
|
* Custom callback for parsing number prefixes from file/folder names.
|
package/src/sidebars/types.ts
CHANGED
|
@@ -254,18 +254,15 @@ export type SidebarItemsGenerator = (
|
|
|
254
254
|
generatorArgs: SidebarItemsGeneratorArgs,
|
|
255
255
|
) => Promise<NormalizedSidebar>;
|
|
256
256
|
|
|
257
|
-
// Also inject the default generator to conveniently wrap/enhance/sort the
|
|
258
|
-
// default sidebar gen logic
|
|
259
|
-
// see https://github.com/facebook/docusaurus/issues/4640#issuecomment-822292320
|
|
260
|
-
export type SidebarItemsGeneratorOptionArgs = {
|
|
261
|
-
/**
|
|
262
|
-
* Useful to re-use/enhance the default sidebar generation logic from
|
|
263
|
-
* Docusaurus.
|
|
264
|
-
*/
|
|
265
|
-
defaultSidebarItemsGenerator: SidebarItemsGenerator;
|
|
266
|
-
} & SidebarItemsGeneratorArgs;
|
|
267
257
|
export type SidebarItemsGeneratorOption = (
|
|
268
|
-
generatorArgs:
|
|
258
|
+
generatorArgs: {
|
|
259
|
+
/**
|
|
260
|
+
* Useful to re-use/enhance the default sidebar generation logic from
|
|
261
|
+
* Docusaurus.
|
|
262
|
+
* @see https://github.com/facebook/docusaurus/issues/4640#issuecomment-822292320
|
|
263
|
+
*/
|
|
264
|
+
defaultSidebarItemsGenerator: SidebarItemsGenerator;
|
|
265
|
+
} & SidebarItemsGeneratorArgs,
|
|
269
266
|
) => Promise<NormalizedSidebarItem[]>;
|
|
270
267
|
|
|
271
268
|
export type SidebarProcessorParams = {
|