From be7367b2f85c366c6343787a78f80ab1c75397b0 Mon Sep 17 00:00:00 2001
From: Yangshun Tay <tay.yang.shun@gmail.com>
Date: Thu, 14 May 2020 11:47:28 +0800
Subject: [PATCH] feat(v2): allow prepending of baseUrl to href in navbar and
 footer (#2746)

---
 .../src/theme/Footer/index.js                  |  6 ++++--
 .../src/theme/Navbar/index.js                  |  4 +++-
 .../src/client/exports/useBaseUrl.ts           |  9 ++++++++-
 website/docs/theme-classic.md                  | 18 +++++++++++++++---
 4 files changed, 30 insertions(+), 7 deletions(-)

diff --git a/packages/docusaurus-theme-classic/src/theme/Footer/index.js b/packages/docusaurus-theme-classic/src/theme/Footer/index.js
index 0c5b8b021c..a3dafd090e 100644
--- a/packages/docusaurus-theme-classic/src/theme/Footer/index.js
+++ b/packages/docusaurus-theme-classic/src/theme/Footer/index.js
@@ -13,8 +13,10 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import useBaseUrl from '@docusaurus/useBaseUrl';
 import styles from './styles.module.css';
 
-function FooterLink({to, href, label, ...props}) {
+function FooterLink({to, href, label, prependBaseUrlToHref, ...props}) {
   const toUrl = useBaseUrl(to);
+  const normalizedHref = useBaseUrl(href, true);
+
   return (
     <Link
       className="footer__link-item"
@@ -22,7 +24,7 @@ function FooterLink({to, href, label, ...props}) {
         ? {
             target: '_blank',
             rel: 'noopener noreferrer',
-            href,
+            href: prependBaseUrlToHref ? normalizedHref : href,
           }
         : {
             to: toUrl,
diff --git a/packages/docusaurus-theme-classic/src/theme/Navbar/index.js b/packages/docusaurus-theme-classic/src/theme/Navbar/index.js
index cee4fbd410..a9dc767aeb 100644
--- a/packages/docusaurus-theme-classic/src/theme/Navbar/index.js
+++ b/packages/docusaurus-theme-classic/src/theme/Navbar/index.js
@@ -26,10 +26,12 @@ function NavLink({
   href,
   label,
   activeClassName = 'navbar__link--active',
+  prependBaseUrlToHref,
   ...props
 }) {
   const toUrl = useBaseUrl(to);
   const activeBaseUrl = useBaseUrl(activeBasePath);
+  const normalizedHref = useBaseUrl(href, true);
 
   return (
     <Link
@@ -37,7 +39,7 @@ function NavLink({
         ? {
             target: '_blank',
             rel: 'noopener noreferrer',
-            href,
+            href: prependBaseUrlToHref ? normalizedHref : href,
           }
         : {
             isNavLink: true,
diff --git a/packages/docusaurus/src/client/exports/useBaseUrl.ts b/packages/docusaurus/src/client/exports/useBaseUrl.ts
index a27d87813c..f7c05f97a9 100644
--- a/packages/docusaurus/src/client/exports/useBaseUrl.ts
+++ b/packages/docusaurus/src/client/exports/useBaseUrl.ts
@@ -7,7 +7,10 @@
 
 import useDocusaurusContext from './useDocusaurusContext';
 
-export default function useBaseUrl(url: string): string {
+export default function useBaseUrl(
+  url: string,
+  forcePrependBaseUrl: boolean = false,
+): string {
   const {siteConfig} = useDocusaurusContext();
   const {baseUrl = '/'} = siteConfig || {};
 
@@ -15,6 +18,10 @@ export default function useBaseUrl(url: string): string {
     return url;
   }
 
+  if (forcePrependBaseUrl) {
+    return baseUrl + url;
+  }
+
   const externalRegex = /^(https?:|\/\/)/;
   if (externalRegex.test(url)) {
     return url;
diff --git a/website/docs/theme-classic.md b/website/docs/theme-classic.md
index a77816c892..3881e79989 100644
--- a/website/docs/theme-classic.md
+++ b/website/docs/theme-classic.md
@@ -132,13 +132,23 @@ module.exports = {
     navbar: {
       links: [
         {
+          // Client-side routing, used for navigating within the website.
+          // The baseUrl will be automatically prepended to this value.
           to: 'docs/introduction',
+          // A full-page navigation, used for navigating outside of the website.
+          // You should only use either `to` or `href`.
+          href: 'https://www.facebook.com',
+          // Prepends the baseUrl to href values.
+          prependBaseUrlToHref: true,
+          // The string to be shown.
           label: 'Introduction',
+          // Left or right side of the navbar.
           position: 'left', // or 'right'
           // To apply the active class styling on all
           // routes starting with this path.
           activeBasePath: 'docs',
-          className: '', // Custom CSS class (for styling any item)
+          // Custom CSS class (for styling any item).
+          className: '',
         },
         // ... other links
       ],
@@ -148,7 +158,7 @@ module.exports = {
 };
 ```
 
-Outbound links automatically get `target="_blank" rel="noopener noreferrer"` attributes.
+Outbound (external) links automatically get `target="_blank" rel="noopener noreferrer"` attributes.
 
 ### Navbar Dropdown
 
@@ -200,7 +210,9 @@ module.exports = {
 
 ## Footer
 
-## `CodeBlock`
+TODO.
+
+## CodeBlock
 
 Docusaurus uses [Prism React Renderer](https://github.com/FormidableLabs/prism-react-renderer) to highlight code blocks.