feat(plugin-docs): docs sidebar item link: support "autoAddBaseUrl" a…

…ttribute (#7949)
facebook · Sep 1, 2022 · 8447a29 · 8447a29
1 parent 7d25a02
commit 8447a29
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 4 deletions.
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/types.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/types.ts
@@ -44,6 +44,7 @@ export type SidebarItemLink = SidebarItemBase & {
   type: 'link';
   href: string;
   label: string;
+  autoAddBaseUrl?: boolean;
 };
 
 export type SidebarItemAutogenerated = SidebarItemBase & {

diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/validation.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/validation.ts
@@ -59,6 +59,7 @@ const sidebarItemHtmlSchema = sidebarItemBaseSchema.append<SidebarItemHtml>({
 const sidebarItemLinkSchema = sidebarItemBaseSchema.append<SidebarItemLink>({
   type: 'link',
   href: URISchema.required(),
+  autoAddBaseUrl: Joi.boolean(),
   label: Joi.string()
     .required()
     .messages({'any.unknown': '"label" must be a string'}),

diff --git a/packages/docusaurus-theme-classic/src/theme/DocSidebarItem/Link/index.tsx b/packages/docusaurus-theme-classic/src/theme/DocSidebarItem/Link/index.tsx
@@ -24,7 +24,7 @@ export default function DocSidebarItemLink({
   index,
   ...props
 }: Props): JSX.Element {
-  const {href, label, className} = item;
+  const {href, label, className, autoAddBaseUrl} = item;
   const isActive = isActiveSidebarItem(item, activePath);
   const isInternalLink = isInternalUrl(href);
   return (
@@ -44,6 +44,7 @@ export default function DocSidebarItemLink({
             'menu__link--active': isActive,
           },
         )}
+        autoAddBaseUrl={autoAddBaseUrl}
         aria-current={isActive ? 'page' : undefined}
         to={href}
         {...(isInternalLink && {

diff --git a/website/_dogfooding/docs-tests-sidebars.js b/website/_dogfooding/docs-tests-sidebars.js
@@ -71,10 +71,27 @@ const sidebars = {
       ],
     },
     {
-      type: 'link',
-      label: 'External link',
-      href: 'https://github.com/facebook/docusaurus',
+      type: 'category',
+      label: 'Link tests',
       className: 'red',
+      items: [
+        {
+          type: 'link',
+          label: 'External link absolute',
+          href: 'https://github.com/facebook/docusaurus',
+        },
+        {
+          type: 'link',
+          label: 'pathname:/// link',
+          href: 'pathname:///some/local/path',
+        },
+        {
+          type: 'link',
+          label: 'pathname:/// link (no baseUrl)',
+          href: 'pathname:///some/local/path',
+          autoAddBaseUrl: false,
+        },
+      ],
     },
     {
       type: 'category',