@docusaurus/plugin-content-docs 2.3.1 → 2.4.1
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/sidebars/types.d.ts
CHANGED
|
@@ -38,6 +38,7 @@ export declare type SidebarItemLink = SidebarItemBase & {
|
|
|
38
38
|
href: string;
|
|
39
39
|
label: string;
|
|
40
40
|
autoAddBaseUrl?: boolean;
|
|
41
|
+
description?: string;
|
|
41
42
|
};
|
|
42
43
|
export declare type SidebarItemAutogenerated = SidebarItemBase & {
|
|
43
44
|
type: 'autogenerated';
|
|
@@ -48,6 +49,7 @@ declare type SidebarItemCategoryBase = SidebarItemBase & {
|
|
|
48
49
|
label: string;
|
|
49
50
|
collapsed: boolean;
|
|
50
51
|
collapsible: boolean;
|
|
52
|
+
description?: string;
|
|
51
53
|
};
|
|
52
54
|
export declare type SidebarItemCategoryLinkDoc = {
|
|
53
55
|
type: 'doc';
|
|
@@ -40,6 +40,9 @@ const sidebarItemLinkSchema = sidebarItemBaseSchema.append({
|
|
|
40
40
|
label: utils_validation_1.Joi.string()
|
|
41
41
|
.required()
|
|
42
42
|
.messages({ 'any.unknown': '"label" must be a string' }),
|
|
43
|
+
description: utils_validation_1.Joi.string().optional().messages({
|
|
44
|
+
'any.unknown': '"description" must be a string',
|
|
45
|
+
}),
|
|
43
46
|
});
|
|
44
47
|
const sidebarItemCategoryLinkSchema = utils_validation_1.Joi.object()
|
|
45
48
|
.allow(null)
|
|
@@ -90,6 +93,9 @@ const sidebarItemCategorySchema = sidebarItemBaseSchema.append({
|
|
|
90
93
|
collapsible: utils_validation_1.Joi.boolean().messages({
|
|
91
94
|
'any.unknown': '"collapsible" must be a boolean',
|
|
92
95
|
}),
|
|
96
|
+
description: utils_validation_1.Joi.string().optional().messages({
|
|
97
|
+
'any.unknown': '"description" must be a string',
|
|
98
|
+
}),
|
|
93
99
|
});
|
|
94
100
|
const sidebarItemSchema = utils_validation_1.Joi.object().when('.type', {
|
|
95
101
|
switch: [
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/plugin-content-docs",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.4.1",
|
|
4
4
|
"description": "Docs plugin for Docusaurus.",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"sideEffects": false,
|
|
@@ -35,13 +35,13 @@
|
|
|
35
35
|
},
|
|
36
36
|
"license": "MIT",
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@docusaurus/core": "2.
|
|
39
|
-
"@docusaurus/logger": "2.
|
|
40
|
-
"@docusaurus/mdx-loader": "2.
|
|
41
|
-
"@docusaurus/module-type-aliases": "2.
|
|
42
|
-
"@docusaurus/types": "2.
|
|
43
|
-
"@docusaurus/utils": "2.
|
|
44
|
-
"@docusaurus/utils-validation": "2.
|
|
38
|
+
"@docusaurus/core": "2.4.1",
|
|
39
|
+
"@docusaurus/logger": "2.4.1",
|
|
40
|
+
"@docusaurus/mdx-loader": "2.4.1",
|
|
41
|
+
"@docusaurus/module-type-aliases": "2.4.1",
|
|
42
|
+
"@docusaurus/types": "2.4.1",
|
|
43
|
+
"@docusaurus/utils": "2.4.1",
|
|
44
|
+
"@docusaurus/utils-validation": "2.4.1",
|
|
45
45
|
"@types/react-router-config": "^5.0.6",
|
|
46
46
|
"combine-promises": "^1.1.0",
|
|
47
47
|
"fs-extra": "^10.1.0",
|
|
@@ -66,5 +66,5 @@
|
|
|
66
66
|
"engines": {
|
|
67
67
|
"node": ">=16.14"
|
|
68
68
|
},
|
|
69
|
-
"gitHead": "
|
|
69
|
+
"gitHead": "60e657d8ae5a4a9ed1c2d777f9defd882cc12681"
|
|
70
70
|
}
|
package/src/sidebars/types.ts
CHANGED
|
@@ -45,6 +45,7 @@ export type SidebarItemLink = SidebarItemBase & {
|
|
|
45
45
|
href: string;
|
|
46
46
|
label: string;
|
|
47
47
|
autoAddBaseUrl?: boolean;
|
|
48
|
+
description?: string;
|
|
48
49
|
};
|
|
49
50
|
|
|
50
51
|
export type SidebarItemAutogenerated = SidebarItemBase & {
|
|
@@ -57,6 +58,7 @@ type SidebarItemCategoryBase = SidebarItemBase & {
|
|
|
57
58
|
label: string;
|
|
58
59
|
collapsed: boolean;
|
|
59
60
|
collapsible: boolean;
|
|
61
|
+
description?: string;
|
|
60
62
|
};
|
|
61
63
|
|
|
62
64
|
export type SidebarItemCategoryLinkDoc = {type: 'doc'; id: string};
|
|
@@ -63,6 +63,9 @@ const sidebarItemLinkSchema = sidebarItemBaseSchema.append<SidebarItemLink>({
|
|
|
63
63
|
label: Joi.string()
|
|
64
64
|
.required()
|
|
65
65
|
.messages({'any.unknown': '"label" must be a string'}),
|
|
66
|
+
description: Joi.string().optional().messages({
|
|
67
|
+
'any.unknown': '"description" must be a string',
|
|
68
|
+
}),
|
|
66
69
|
});
|
|
67
70
|
|
|
68
71
|
const sidebarItemCategoryLinkSchema = Joi.object<SidebarItemCategoryLink>()
|
|
@@ -116,6 +119,9 @@ const sidebarItemCategorySchema =
|
|
|
116
119
|
collapsible: Joi.boolean().messages({
|
|
117
120
|
'any.unknown': '"collapsible" must be a boolean',
|
|
118
121
|
}),
|
|
122
|
+
description: Joi.string().optional().messages({
|
|
123
|
+
'any.unknown': '"description" must be a string',
|
|
124
|
+
}),
|
|
119
125
|
});
|
|
120
126
|
|
|
121
127
|
const sidebarItemSchema = Joi.object<SidebarItemConfig>().when('.type', {
|