From 03caefbb02854d5c98a26d889e0e30c910651395 Mon Sep 17 00:00:00 2001 From: Giteabot Date: Sat, 9 Mar 2024 00:53:36 +0800 Subject: [PATCH] Fix user-defined markup links targets (#29305) (#29666) Backport #29305 by @DanielMatiasCarvalho This seeks to fix the bug reported on issue #29196. Cause: ID's with custom characters (- , _ , etc.), were not linking correctly in the Markdown file when rendered in the browser because the ID in the respective destinies would be different than the one in anchor, while for IDs with only letters, the ID would be the same. Fix: It was suggested that to fix this bug, it should more or less like GitHub does it. While in gitea the anchors would be put in HTML like this: ```

Review

Staging

Development

Testing

Unit-tests

``` In GitHub, the same anchor's href properties would be the same without "user-content-" trailing behind. So my code made sure to change those anchors, so it would not include "user-content-" and then add respective Event Listeners so it would scroll into the supposed places. Fixes: #29196 Co-authored-by: DC <106393991+DanielMatiasCarvalho@users.noreply.github.com> Co-authored-by: silverwind (cherry picked from commit bfc7c8a5985825ec28f3feefe1d050ec52525097) --- web_src/js/markup/anchors.js | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/web_src/js/markup/anchors.js b/web_src/js/markup/anchors.js index 53dfa2980c..03934ea215 100644 --- a/web_src/js/markup/anchors.js +++ b/web_src/js/markup/anchors.js @@ -2,6 +2,7 @@ import {svg} from '../svg.js'; const headingSelector = '.markup h1, .markup h2, .markup h3, .markup h4, .markup h5, .markup h6'; +// scroll to anchor while respecting the `user-content` prefix that exists on the target function scrollToAnchor(hash, initial) { // abort if the browser has already scrolled to another anchor during page load if (initial && document.querySelector(':target')) return; @@ -19,6 +20,7 @@ function scrollToAnchor(hash, initial) { export function initMarkupAnchors() { if (!document.querySelector('.markup')) return; + // create link icons for markup headings, the resulting link href will remove `user-content-` for (const heading of document.querySelectorAll(headingSelector)) { const originalId = heading.id.replace(/^user-content-/, ''); const a = document.createElement('a'); @@ -31,5 +33,18 @@ export function initMarkupAnchors() { heading.prepend(a); } + // handle user-defined `name` anchors like `[Link](#link)` linking to `Link` + for (const a of document.querySelectorAll('.markup a[href^="#"]')) { + const href = a.getAttribute('href'); + if (!href.startsWith('#user-content-')) continue; + const originalId = href.replace(/^#user-content-/, ''); + a.setAttribute('href', `#${encodeURIComponent(originalId)}`); + if (document.getElementsByName(originalId).length !== 1) { + a.addEventListener('click', (e) => { + scrollToAnchor(e.currentTarget.getAttribute('href'), false); + }); + } + } + scrollToAnchor(window.location.hash, true); }