Skip to content

feat(content-docs): add support for sidebar item category/link descriptions in generated index page #8236

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

Merged
slorber merged 11 commits into from
Mar 16, 2023
+67 −11
Merged

feat(content-docs): add support for sidebar item category/link descriptions in generated index page #8236

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4348c6a
feat: Introduced description to SidebarItemLink
ZarakiKanzaki Oct 22, 2022
fdd8c73
feat: managed to display description of External link in DocCard
ZarakiKanzaki Oct 22, 2022
032721c
feat: added external link with description for dogfooding
ZarakiKanzaki Oct 22, 2022
143999b
fix: solved problem related with react hooks executed conditionally
ZarakiKanzaki Oct 22, 2022
dddb70f
feat: Added chenges to categories
ZarakiKanzaki Oct 24, 2022
8000537
fix: removed console log from DocCard
ddonadio-claranet Oct 26, 2022
ccfbd26
fix: edit types and Card Doc based on suggestion on PR
ddonadio-claranet Oct 28, 2022
7ab9933
Merge branch 'main' into 7818-Category-auto-generated-index-page-shou…
slorber Mar 15, 2023
c8605c3
add dogfood for link/category item description
slorber Mar 15, 2023
6d6dee5
reduce unneeded diff
slorber Mar 15, 2023
d4b1431
add basic API docs
slorber Mar 15, 2023
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
2 changes: 2 additions & 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 @@ -45,6 +45,7 @@ export type SidebarItemLink = SidebarItemBase & {
href: string;
label: string;
autoAddBaseUrl?: boolean;
description?: string;
};

export type SidebarItemAutogenerated = SidebarItemBase & {
Expand All @@ -69,6 +70,7 @@ export type SidebarItemCategoryLinkGeneratedIndexConfig = {
image?: string;
keywords?: string | readonly string[];
};

export type SidebarItemCategoryLinkGeneratedIndex = {
type: 'generated-index';
slug: string;
Expand Down
3 changes: 3 additions & 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 @@ -63,6 +63,9 @@ const sidebarItemLinkSchema = sidebarItemBaseSchema.append<SidebarItemLink>({
label: Joi.string()
.required()
.messages({'any.unknown': '"label" must be a string'}),
description: Joi.string().optional().messages({
'any.unknown': '"description" must be a string',
}),
});

const sidebarItemCategoryLinkSchema = Joi.object<SidebarItemCategoryLink>()
Expand Down
4 changes: 3 additions & 1 deletion packages/docusaurus-theme-classic/src/theme/DocCard/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,9 @@ function CardLink({item}: {item: PropSidebarItemLink}): JSX.Element {
href={item.href}
icon={icon}
title={item.label}
description={doc?.description}
description={
isInternalUrl(item.href) ? doc?.description : item.description
}
/>
);
}
Expand Down
6 changes: 6 additions & 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 @@ -39,6 +39,12 @@ const sidebars = {
label: 'External Link test',
href: 'https://docusaurus.io',
},
{
type: 'link',
label: 'External Link with description',
href: 'https://docusaurus.io',
description: 'Some description',
},
],
},
{
Expand Down