3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-31 07:18:59 +02:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source 
Co-authored-by: Davide Donadio <davide.donadio@it.clara.net>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
This commit is contained in:
Davide Donadio 2023-03-16 10:14:42 +01:00 • committed by GitHub
parent ca86fab2c9
commit 5c271f5622
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 67 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

2
website/docs/guides/docs/sidebar/items.mdx
View file

@ -85,6 +85,7 @@ type SidebarItemLink = {
label: string;
href: string;
className?: string;
description?: string;
};
```
@ -173,6 +174,7 @@ type SidebarItemCategory = {
label: string; // Sidebar label text.
items: SidebarItem[]; // Array of sidebar items.
className?: string;
description?: string;
// Category options:
collapsible: boolean; // Set the category to be collapsible

2
website/docs/guides/docs/sidebar/multiple-sidebars.mdx
View file

@ -116,7 +116,7 @@ The pagination label by default is the sidebar label. You can use the front matt
## The `ref` item {#sidebar-item-ref}
The `ref` type is identical to the [`doc` type](#sidebar-item-doc) in every way, except that it doesn't participate in generating navigation metadata. It only registers itself as a link. When [generating pagination](#generating-pagination) and [displaying sidebar](#sidebar-association), `ref` items are completely ignored.
The `ref` type is identical to the [`doc` type](./items.mdx#sidebar-item-doc) in every way, except that it doesn't participate in generating navigation metadata. It only registers itself as a link. When [generating pagination](#generating-pagination) and [displaying sidebar](#sidebar-association), `ref` items are completely ignored.
It is particularly useful where you wish to link to the same document from multiple sidebars. The document only belongs to one sidebar (the one where it's registered as `type: 'doc'` or from an autogenerated directory), but its link will appear in all sidebars that it's registered in.