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.

Sign up for GitHub

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(docs): the _category_.json description attribute should display on generated index pages #10324

Merged
merged 9 commits into from
Aug 9, 2024
Merged

fix(docs): the _category_.json description attribute should display on generated index pages #10324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
53c6c8e
changed validation parameters and accepted description parameters from
bharateshwq Jul 21, 2024
5a8ebd3
demonstration of the bugfix
bharateshwq Jul 21, 2024
03feca7
final commit since the builds were failing
bharateshwq Jul 21, 2024
7cdbfd2
add dogfood test case
slorber Aug 9, 2024
2e0b1f3
add dogfood test case
slorber Aug 9, 2024
37a7742
add validation test
slorber Aug 9, 2024
326b30c
remove useless code
slorber Aug 9, 2024
6c31f42
polish
slorber Aug 9, 2024
95d31e0
add _category_ description to unit test snapshot
slorber Aug 9, 2024
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
1 change: 1 addition & 0 deletions ...ocusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,7 @@ exports[`DefaultSidebarItemsGenerator uses explicit link over the index/readme.{
{
"collapsed": undefined,
"collapsible": undefined,
"description": "Category description",
"items": [
{
"id": "parent/doc2",
Expand Down
1 change: 1 addition & 0 deletions packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,7 @@ describe('DefaultSidebarItemsGenerator', () => {
categoriesMetadata: {
Category: {
label: 'Category label',
description: 'Category description',
link: {
type: 'doc',
id: 'doc3', // Using a "local doc id" ("doc1" instead of "parent/doc1") on purpose
Expand Down
1 change: 1 addition & 0 deletions packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/validation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,7 @@ describe('validateCategoryMetadataFile', () => {
const content: CategoryMetadataFile = {
className: 'className',
label: 'Category Label',
description: 'Category Description',
link: {
type: 'generated-index',
slug: 'slug',
Expand Down
3 changes: 3 additions & 0 deletions packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,9 @@ Available doc IDs:
...(customProps !== undefined && {customProps}),
...(className !== undefined && {className}),
items,
...(categoryMetadata?.description && {
description: categoryMetadata?.description,
}),
...(link && {link}),
};
}
Expand Down
1 change: 1 addition & 0 deletions packages/docusaurus-plugin-content-docs/src/sidebars/postProcessor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ function postProcessSidebarItem(
.map((subItem) => postProcessSidebarItem(subItem, params))
.filter((v): v is SidebarItem => Boolean(v)),
};

// If the current category doesn't have subitems, we render a normal link
// instead.
if (category.items.length === 0) {
Expand Down
1 change: 1 addition & 0 deletions packages/docusaurus-plugin-content-docs/src/sidebars/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,7 @@ export type PropSidebarBreadcrumbsItem =
export type CategoryMetadataFile = {
label?: string;
position?: number;
description?: string;
collapsed?: boolean;
collapsible?: boolean;
className?: string;
Expand Down
1 change: 1 addition & 0 deletions packages/docusaurus-plugin-content-docs/src/sidebars/validation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ export function validateSidebars(sidebars: {

const categoryMetadataFileSchema = Joi.object<CategoryMetadataFile>({
label: Joi.string(),
description: Joi.string(),
position: Joi.number(),
collapsed: Joi.boolean(),
collapsible: Joi.boolean(),
Expand Down
1 change: 1 addition & 0 deletions website/_dogfooding/_docs tests/tests/category-links/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"label": "Category Links",
"description": "Category Links - Custom Description",
"link": {
"type": "generated-index",
"slug": "/category-links-generated-index-slug"
Expand Down
1 change: 1 addition & 0 deletions website/_dogfooding/docs-tests-sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ const sidebars = {
{
type: 'category',
label: 'Sidebar item description tests',
description: 'Some custom category description',
link: {
type: 'generated-index',
},
Expand Down