]> git.ipfire.org Git - thirdparty/fastapi/sqlmodel.git/commitdiff
🔨 Handle external links `target=_blank` and CSS automatically in JS and CSS (#1799)
authorSebastián Ramírez <tiangolo@gmail.com>
Thu, 5 Mar 2026 18:23:45 +0000 (10:23 -0800)
committerGitHub <noreply@github.com>
Thu, 5 Mar 2026 18:23:45 +0000 (18:23 +0000)
docs/css/custom.css
docs/js/custom.js

index 6ac827ff071f99aa5fb1168b7934a16ad9ad866a..a1267e60bd9d0a971b2dabcacd9d72d5f98f63d1 100644 (file)
     display: none;
 }
 
-a.external-link::after {
-    /* \00A0 is a non-breaking space
-        to make the mark be on the same line as the link
-    */
-    content: "\00A0[↪]";
-}
-
-a.internal-link::after {
-    /* \00A0 is a non-breaking space
-        to make the mark be on the same line as the link
-    */
-    content: "\00A0↪";
+/* 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[data-external-link]:not(:has(img)):not(.no-link-icon):not(.announce-link) {
+  /* For right to left languages */
+  direction: ltr;
+  display: inline-block;
+}
+
+a[data-external-link]:not(:has(img)):not(.no-link-icon):not(.announce-link)::after {
+  content: "";
+  display: inline-block;
+  width: 0.75em;
+  height: 0.75em;
+  margin-left: 0.25em;
+  vertical-align: middle;
+  opacity: 0.55;
+  background: currentColor;
+  -webkit-mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='currentColor' stroke-width='2.5' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6'/%3E%3Cpolyline points='15 3 21 3 21 9'/%3E%3Cline x1='10' y1='14' x2='21' y2='3'/%3E%3C/svg%3E");
+  -webkit-mask-size: contain;
+  -webkit-mask-repeat: no-repeat;
+  mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='currentColor' stroke-width='2.5' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6'/%3E%3Cpolyline points='15 3 21 3 21 9'/%3E%3Cline x1='10' y1='14' x2='21' y2='3'/%3E%3C/svg%3E");
+  mask-size: contain;
+  mask-repeat: no-repeat;
+}
+
+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: 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[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[data-internal-link][target="_blank"]:not(:has(img)):not(.no-link-icon):not(.announce-link)::after {
+  content: "";
+  display: inline-block;
+  width: 0.75em;
+  height: 0.75em;
+  margin-left: 0.25em;
+  vertical-align: middle;
+  opacity: 0.55;
+  background: currentColor;
+  -webkit-mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='currentColor' stroke-width='2.5' stroke-linecap='round' stroke-linejoin='round'%3E%3Crect x='3' y='7' width='14' height='14' rx='2'/%3E%3Cpath d='M7 3h14v14'/%3E%3C/svg%3E");
+  -webkit-mask-size: contain;
+  -webkit-mask-repeat: no-repeat;
+  mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='currentColor' stroke-width='2.5' stroke-linecap='round' stroke-linejoin='round'%3E%3Crect x='3' y='7' width='14' height='14' rx='2'/%3E%3Cpath d='M7 3h14v14'/%3E%3C/svg%3E");
+  mask-size: contain;
+  mask-repeat: no-repeat;
+}
+
+a[data-internal-link][target="_blank"]:not(:has(img)):not(.no-link-icon):not(.announce-link):hover::after {
+  opacity: 0.85;
+}
+
+/* Disable link icons in footer and header nav */
+.md-footer a::after,
+.md-header a::after {
+  content: none !important;
 }
 
 .shadow {
index 82c1d45570db943d93a4397b53d88c1aa3988135..29f2bf8524aa0de30a830940738892bc21b9aff1 100644 (file)
@@ -109,8 +109,36 @@ function setupTermynal() {
     loadVisibleTermynals();
 }
 
+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()
+    setupTermynal();
+    openLinksInNewTab();
 }
 
 document$.subscribe(() => {