]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commitdiff
🔨 Add JS and CSS handling for automatic `target=_blank` for links in docs (#15063)
authorSebastián Ramírez <tiangolo@gmail.com>
Thu, 5 Mar 2026 17:59:48 +0000 (09:59 -0800)
committerGitHub <noreply@github.com>
Thu, 5 Mar 2026 17:59:48 +0000 (18:59 +0100)
docs/en/docs/css/custom.css
docs/en/docs/js/custom.js

index b88d694845391e2db412181a8c9b6796026e5323..e207197c7527e55f8f01e36cf194bbb84c58593a 100644 (file)
   display: none;
 }
 
-/* External links: absolute URLs opening in new tab
+/* External links: detected by JS comparing origin to site origin
+   JS sets data-external-link on links pointing outside the site
    Skip image links, .no-link-icon, and .announce-link */
-a[target="_blank"][href^="http"]:not(:has(img)):not(.no-link-icon):not(.announce-link) {
+a[data-external-link]:not(:has(img)):not(.no-link-icon):not(.announce-link) {
   /* For right to left languages */
   direction: ltr;
   display: inline-block;
 }
 
-a[target="_blank"][href^="http"]:not(:has(img)):not(.no-link-icon):not(.announce-link)::after {
+a[data-external-link]:not(:has(img)):not(.no-link-icon):not(.announce-link)::after {
   content: "";
   display: inline-block;
   width: 0.75em;
@@ -57,19 +58,20 @@ a[target="_blank"][href^="http"]:not(:has(img)):not(.no-link-icon):not(.announce
   mask-repeat: no-repeat;
 }
 
-a[target="_blank"][href^="http"]:not(:has(img)):not(.no-link-icon):not(.announce-link):hover::after {
+a[data-external-link]:not(:has(img)):not(.no-link-icon):not(.announce-link):hover::after {
   opacity: 0.85;
 }
 
-/* Internal links opening in new tab: relative URLs with target=_blank
+/* Internal links opening in new tab: same-origin links with target=_blank
+   JS sets data-internal-link on links pointing to the same site origin
    Skip image links, .no-link-icon, and .announce-link */
-a[target="_blank"]:not([href^="http"]):not(:has(img)):not(.no-link-icon):not(.announce-link) {
+a[data-internal-link][target="_blank"]:not(:has(img)):not(.no-link-icon):not(.announce-link) {
   /* For right to left languages */
   direction: ltr;
   display: inline-block;
 }
 
-a[target="_blank"]:not([href^="http"]):not(:has(img)):not(.no-link-icon):not(.announce-link)::after {
+a[data-internal-link][target="_blank"]:not(:has(img)):not(.no-link-icon):not(.announce-link)::after {
   content: "";
   display: inline-block;
   width: 0.75em;
@@ -86,7 +88,7 @@ a[target="_blank"]:not([href^="http"]):not(:has(img)):not(.no-link-icon):not(.an
   mask-repeat: no-repeat;
 }
 
-a[target="_blank"]:not([href^="http"]):not(:has(img)):not(.no-link-icon):not(.announce-link):hover::after {
+a[data-internal-link][target="_blank"]:not(:has(img)):not(.no-link-icon):not(.announce-link):hover::after {
   opacity: 0.85;
 }
 
index be326d30297ac74bd0880ba21776838a403e3fc5..311995d7cd98e8ab4d9703ad98ad0a719f6416c7 100644 (file)
@@ -174,10 +174,38 @@ function handleSponsorImages() {
         });
 }
 
+function openLinksInNewTab() {
+    const siteUrl = document.querySelector("link[rel='canonical']")?.href
+        || window.location.origin;
+    const siteOrigin = new URL(siteUrl).origin;
+    document.querySelectorAll(".md-content a[href]").forEach(a => {
+        if (a.getAttribute("target") === "_self") return;
+        const href = a.getAttribute("href");
+        if (!href) return;
+        try {
+            const url = new URL(href, window.location.href);
+            // Skip same-page anchor links (only the hash differs)
+            if (url.origin === window.location.origin
+                && url.pathname === window.location.pathname
+                && url.search === window.location.search) return;
+            if (!a.hasAttribute("target")) {
+                a.setAttribute("target", "_blank");
+                a.setAttribute("rel", "noopener");
+            }
+            if (url.origin !== siteOrigin) {
+                a.dataset.externalLink = "";
+            } else {
+                a.dataset.internalLink = "";
+            }
+        } catch (_) {}
+    });
+}
+
 async function main() {
     setupTermynal();
     showRandomAnnouncement('announce-left', 5000)
     handleSponsorImages();
+    openLinksInNewTab();
 }
 document$.subscribe(() => {
     main()