From ec109737e9a103767ca185d2da47597325533a76 Mon Sep 17 00:00:00 2001 From: Andrew Lyons Date: Tue, 12 Apr 2022 15:59:41 +0800 Subject: [PATCH] docs: explain more clearly the purpose of a ref sidebar type (#7159) --- website/docs/guides/docs/sidebar/multiple-sidebars.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/docs/guides/docs/sidebar/multiple-sidebars.md b/website/docs/guides/docs/sidebar/multiple-sidebars.md index 9a2029db13..b97e4b5d12 100644 --- a/website/docs/guides/docs/sidebar/multiple-sidebars.md +++ b/website/docs/guides/docs/sidebar/multiple-sidebars.md @@ -118,6 +118,8 @@ The pagination label by default is the sidebar label. You can use the front matt 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. +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. + Consider this example: ```js title="sidebars.js"