@docusaurus/plugin-content-docs 0.0.0-6019 → 0.0.0-6021
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/generator.js +3 -0
- package/lib/sidebars/types.d.ts +1 -0
- package/lib/sidebars/validation.js +1 -0
- package/package.json +11 -11
- package/src/sidebars/generator.ts +3 -0
- package/src/sidebars/postProcessor.ts +1 -0
- package/src/sidebars/types.ts +1 -0
- package/src/sidebars/validation.ts +1 -0
|
@@ -168,6 +168,9 @@ Available doc IDs:
|
|
|
168
168
|
...(customProps !== undefined && { customProps }),
|
|
169
169
|
...(className !== undefined && { className }),
|
|
170
170
|
items,
|
|
171
|
+
...(categoryMetadata?.description && {
|
|
172
|
+
description: categoryMetadata?.description,
|
|
173
|
+
}),
|
|
171
174
|
...(link && { link }),
|
|
172
175
|
};
|
|
173
176
|
}
|
package/lib/sidebars/types.d.ts
CHANGED
|
@@ -138,6 +138,7 @@ export type PropSidebarBreadcrumbsItem = PropSidebarItemLink | PropSidebarItemCa
|
|
|
138
138
|
export type CategoryMetadataFile = {
|
|
139
139
|
label?: string;
|
|
140
140
|
position?: number;
|
|
141
|
+
description?: string;
|
|
141
142
|
collapsed?: boolean;
|
|
142
143
|
collapsible?: boolean;
|
|
143
144
|
className?: string;
|
|
@@ -133,6 +133,7 @@ function validateSidebars(sidebars) {
|
|
|
133
133
|
}
|
|
134
134
|
const categoryMetadataFileSchema = utils_validation_1.Joi.object({
|
|
135
135
|
label: utils_validation_1.Joi.string(),
|
|
136
|
+
description: utils_validation_1.Joi.string(),
|
|
136
137
|
position: utils_validation_1.Joi.number(),
|
|
137
138
|
collapsed: utils_validation_1.Joi.boolean(),
|
|
138
139
|
collapsible: utils_validation_1.Joi.boolean(),
|
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-6021",
|
|
4
4
|
"description": "Docs plugin for Docusaurus.",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"sideEffects": false,
|
|
@@ -35,15 +35,15 @@
|
|
|
35
35
|
},
|
|
36
36
|
"license": "MIT",
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@docusaurus/core": "0.0.0-
|
|
39
|
-
"@docusaurus/logger": "0.0.0-
|
|
40
|
-
"@docusaurus/mdx-loader": "0.0.0-
|
|
41
|
-
"@docusaurus/module-type-aliases": "0.0.0-
|
|
42
|
-
"@docusaurus/theme-common": "0.0.0-
|
|
43
|
-
"@docusaurus/types": "0.0.0-
|
|
44
|
-
"@docusaurus/utils": "0.0.0-
|
|
45
|
-
"@docusaurus/utils-common": "0.0.0-
|
|
46
|
-
"@docusaurus/utils-validation": "0.0.0-
|
|
38
|
+
"@docusaurus/core": "0.0.0-6021",
|
|
39
|
+
"@docusaurus/logger": "0.0.0-6021",
|
|
40
|
+
"@docusaurus/mdx-loader": "0.0.0-6021",
|
|
41
|
+
"@docusaurus/module-type-aliases": "0.0.0-6021",
|
|
42
|
+
"@docusaurus/theme-common": "0.0.0-6021",
|
|
43
|
+
"@docusaurus/types": "0.0.0-6021",
|
|
44
|
+
"@docusaurus/utils": "0.0.0-6021",
|
|
45
|
+
"@docusaurus/utils-common": "0.0.0-6021",
|
|
46
|
+
"@docusaurus/utils-validation": "0.0.0-6021",
|
|
47
47
|
"@types/react-router-config": "^5.0.7",
|
|
48
48
|
"combine-promises": "^1.1.0",
|
|
49
49
|
"fs-extra": "^11.1.1",
|
|
@@ -67,5 +67,5 @@
|
|
|
67
67
|
"engines": {
|
|
68
68
|
"node": ">=18.0"
|
|
69
69
|
},
|
|
70
|
-
"gitHead": "
|
|
70
|
+
"gitHead": "7876673a736b8c3d5715a8edb6cb21bf464d9315"
|
|
71
71
|
}
|
|
@@ -249,6 +249,9 @@ Available doc IDs:
|
|
|
249
249
|
...(customProps !== undefined && {customProps}),
|
|
250
250
|
...(className !== undefined && {className}),
|
|
251
251
|
items,
|
|
252
|
+
...(categoryMetadata?.description && {
|
|
253
|
+
description: categoryMetadata?.description,
|
|
254
|
+
}),
|
|
252
255
|
...(link && {link}),
|
|
253
256
|
};
|
|
254
257
|
}
|
|
@@ -64,6 +64,7 @@ function postProcessSidebarItem(
|
|
|
64
64
|
.map((subItem) => postProcessSidebarItem(subItem, params))
|
|
65
65
|
.filter((v): v is SidebarItem => Boolean(v)),
|
|
66
66
|
};
|
|
67
|
+
|
|
67
68
|
// If the current category doesn't have subitems, we render a normal link
|
|
68
69
|
// instead.
|
|
69
70
|
if (category.items.length === 0) {
|
package/src/sidebars/types.ts
CHANGED
|
@@ -167,6 +167,7 @@ export function validateSidebars(sidebars: {
|
|
|
167
167
|
|
|
168
168
|
const categoryMetadataFileSchema = Joi.object<CategoryMetadataFile>({
|
|
169
169
|
label: Joi.string(),
|
|
170
|
+
description: Joi.string(),
|
|
170
171
|
position: Joi.number(),
|
|
171
172
|
collapsed: Joi.boolean(),
|
|
172
173
|
collapsible: Joi.boolean(),
|