mkdocs · reteps · Apr 29, 2025 · Apr 29, 2025 · May 13, 2025 · May 13, 2025
diff --git a/mkdocs_redirects/plugin.py b/mkdocs_redirects/plugin.py
@@ -2,26 +2,51 @@
 Copyright 2019-2022 DataRobot, Inc. and its affiliates.
 All rights reserved.
 """
-import logging
+from __future__ import annotations
+
 import os
 import posixpath
+from typing import TypedDict
 
 from mkdocs import utils
 from mkdocs.config import config_options
-from mkdocs.plugins import BasePlugin
+from mkdocs.plugins import BasePlugin, get_plugin_logger
 from mkdocs.structure.files import File
 
-log = logging.getLogger("mkdocs.plugin.redirects")
+log = get_plugin_logger(__name__)
+
 
+def gen_anchor_redirects(anchor_list: list):
+    """
+    Generate a dictionary of redirects for anchors.
 
+    :param anchor_list: A list of tuples containing old anchors and new links.
+    :return: A string of JavaScript redirects for the anchors.
+    """
+    js_redirects = ""
+    for old_anchor, new_link in anchor_list:
+        # Create a JavaScript redirect for each anchor
+        js_redirects += f"""
+        if (window.location.hash === "{old_anchor}") {{
+            location.href = "{new_link}";
+        }}
+        """
+    return js_redirects
+
+
+# This template is used to generate the HTML file for the redirect.
 HTML_TEMPLATE = """
 <!doctype html>
 <html lang="en">
 <head>
     <meta charset="utf-8">
     <title>Redirecting...</title>
     <link rel="canonical" href="{url}">
-    <script>var anchor=window.location.hash.substr(1);location.href="{url}"+(anchor?"#"+anchor:"")</script>
+    <script>
+        var anchor = window.location.hash.substr(1);
+        location.href = `{url}${{anchor ? '#' + anchor : ''}}`;
+        {redirects}
+    </script>
     <meta http-equiv="refresh" content="0; url={url}">
 </head>
 <body>
@@ -30,8 +55,14 @@
 </html>
 """
 
+JS_INJECT_EXISTS = """
+<script>
+    {redirects}
+</script>
+"""
+
 
-def write_html(site_dir, old_path, new_path):
+def write_html(site_dir: str, old_path: str, new_path: str, anchor_list: list[tuple[str, str]]):
     """Write an HTML file in the site_dir with a meta redirect to the new page"""
     # Determine all relevant paths
     old_path_abs = os.path.join(site_dir, old_path)
@@ -45,7 +76,8 @@ def write_html(site_dir, old_path, new_path):
 
     # Write the HTML redirect file in place of the old file
     log.debug("Creating redirect: '%s' -> '%s'", old_path, new_path)
-    content = HTML_TEMPLATE.format(url=new_path)
+    redirects = gen_anchor_redirects(anchor_list)  # Example anchor map
+    content = HTML_TEMPLATE.format(url=new_path, redirects=redirects)
     with open(old_path_abs, "w", encoding="utf-8") as f:
         f.write(content)
 
@@ -68,56 +100,137 @@ def get_html_path(path, use_directory_urls):
     return f.dest_path.replace(os.sep, "/")
 
 
+class RedirectEntry(TypedDict):
+    hashes: list[tuple[str, str]]
+    overall: str
+
+
+def build_redirect_entries(redirects: dict):
+    redirect_entries: dict[str, RedirectEntry] = {}
+    for page_old, page_new in redirects.items():
+        page_old_without_hash, old_hash = _split_hash_fragment(str(page_old))
+        if page_old_without_hash not in redirect_entries:
+            redirect_entries[page_old_without_hash] = {"hashes": [], "overall": ""}
+        if old_hash == "":
+            redirect_entries[page_old_without_hash]["overall"] = page_new
+        else:
+            redirect_entries[page_old_without_hash]["hashes"].append((old_hash, page_new))
+
+    # If a page doesn't have an overall redirect, use the first hash redirect
+    for page_old, redirect_map in redirect_entries.items():
+        if redirect_map.get("overall", "") == "":
+            redirect_entries[page_old]["overall"] = redirect_map["hashes"][0][1]
+
+    return redirect_entries
+
+
 class RedirectPlugin(BasePlugin):
     # Any options that this plugin supplies should go here.
     config_scheme = (
         ("redirect_maps", config_options.Type(dict, default={})),  # note the trailing comma
     )
 
+    redirect_entries: dict[str, RedirectEntry] = {}
+
     # Build a list of redirects on file generation
     def on_files(self, files, config, **kwargs):
         self.redirects = self.config.get("redirect_maps", {})
 
         # Validate user-provided redirect "old files"
         for page_old in self.redirects:
-            if not utils.is_markdown_file(page_old):
-                log.warning("redirects plugin: '%s' is not a valid markdown file!", page_old)
+            page_old_without_hash, _ = _split_hash_fragment(str(page_old))
+            if not utils.is_markdown_file(page_old_without_hash):
+                log.warning(
+                    "redirects plugin: '%s' is not a valid markdown file!", page_old_without_hash
+                )
 
         # Build a dict of known document pages to validate against later
         self.doc_pages = {}
         for page in files.documentation_pages():  # object type: mkdocs.structure.files.File
             self.doc_pages[page.src_path.replace(os.sep, "/")] = page
 
+        # Create a dictionary to hold anchor maps for redirects
+
+        self.redirect_entries = build_redirect_entries(self.redirects)
+
+    def on_page_content(self, html, page, config, files):
+        use_directory_urls = config.get("use_directory_urls")
+        page_old = page.file.src_uri
+        if page_old not in self.redirect_entries:
+            return html
+
+        # Fixup redirect_entries to use the correct path
+        for i in range(len(self.redirect_entries[page_old]["hashes"])):
+            old_hash, new_link = self.redirect_entries[page_old]["hashes"][i]
+            hash_redirect_without_hash, new_hash = _split_hash_fragment(str(new_link))
+            if hash_redirect_without_hash in self.doc_pages:
+                file = self.doc_pages[hash_redirect_without_hash]
+                dest_hash_path = get_relative_html_path(
+                    page_old, file.url + new_hash, use_directory_urls
+                )
+                self.redirect_entries[page_old]["hashes"][i] = (old_hash, dest_hash_path)
+
+        for old_hash, new_link in self.redirect_entries[page_old]["hashes"]:
+            log.info(f"Injecting redirect for '{page_old}{old_hash}' to '{new_link}'")
+
+        js_redirects = JS_INJECT_EXISTS.format(
+            redirects=gen_anchor_redirects(self.redirect_entries[page_old]["hashes"])
+        )
+        return js_redirects + html
+
     # Create HTML files for redirects after site dir has been built
     def on_post_build(self, config, **kwargs):
         # Determine if 'use_directory_urls' is set
         use_directory_urls = config.get("use_directory_urls")
-
-        # Walk through the redirect map and write their HTML files
-        for page_old, page_new in self.redirects.items():
+        for page_old, redirect_entry in self.redirect_entries.items():
             # Need to remove hash fragment from new page to verify existence
-            page_new_without_hash, hash = _split_hash_fragment(str(page_new))
+            page_new = redirect_entry["overall"]
+            page_old_without_hash, _ = _split_hash_fragment(str(page_old))
+            page_new_without_hash, new_hash = _split_hash_fragment(str(page_new))
 
             # External redirect targets are easy, just use it as the target path
             if page_new.lower().startswith(("http://", "https://")):
                 dest_path = page_new
 
+            # If the redirect target is a valid internal page, we need to create a relative path
             elif page_new_without_hash in self.doc_pages:
                 file = self.doc_pages[page_new_without_hash]
-                dest_path = get_relative_html_path(page_old, file.url + hash, use_directory_urls)
+                dest_path = get_relative_html_path(
+                    page_old, file.url + new_hash, use_directory_urls
+                )
 
             # If the redirect target isn't external or a valid internal page, throw an error
             # Note: we use 'warn' here specifically; mkdocs treats warnings specially when in strict mode
             else:
                 log.warning("Redirect target '%s' does not exist!", page_new)
                 continue
 
-            # DO IT!
-            write_html(
-                config["site_dir"],
-                get_html_path(page_old, use_directory_urls),
-                dest_path,
-            )
+            # Fixup redirect_entry to use the correct path
+            for i in range(len(redirect_entry["hashes"])):
+                old_hash, new_link = redirect_entry["hashes"][i]
+                hash_redirect_without_hash, new_hash = _split_hash_fragment(str(new_link))
+                if hash_redirect_without_hash in self.doc_pages:
+                    file = self.doc_pages[hash_redirect_without_hash]
+                    dest_hash_path = get_relative_html_path(
+                        page_old, file.url + new_hash, use_directory_urls
+                    )
+                    redirect_entry["hashes"][i] = (old_hash, dest_hash_path)
+
+            if page_old_without_hash in self.doc_pages:
+                # If the old page is a valid document page, it was injected in `on_page_content`.
+                pass
+            else:
+                log.info(f"Creating redirect for '{page_old}' to '{dest_path}'")
+                for old_hash, new_link in redirect_entry["hashes"]:
+                    log.info(f"Creating redirect for '{page_old}{old_hash}' to '{new_link}'")
+                # Otherwise, create a new HTML file for the redirect
+                dest_path = get_relative_html_path(page_old, dest_path, use_directory_urls)
+                write_html(
+                    config["site_dir"],
+                    get_html_path(page_old, use_directory_urls),
+                    dest_path,
+                    redirect_entry["hashes"],
+                )
 
 
 def _split_hash_fragment(path):

diff --git a/tests/test_plugin.py b/tests/test_plugin.py
@@ -5,6 +5,7 @@
 
 import pytest
 from mkdocs.structure.files import File
+from mkdocs.structure.pages import Page
 
 from mkdocs_redirects import plugin
 
@@ -27,21 +28,25 @@
 def run_redirect_test(monkeypatch, old_page, new_page, use_directory_urls):
     wrote = ()
 
-    def write_html(site_dir, old_path, new_path):
+    def write_html(site_dir, old_path, new_path, anchor_list):
         nonlocal wrote
         wrote = (old_path, new_path)
 
     monkeypatch.setattr(plugin, "write_html", write_html)
 
     plg = plugin.RedirectPlugin()
     plg.redirects = {old_page: new_page}
+    plg.redirect_entries = plugin.build_redirect_entries(plg.redirects)
     plg.doc_pages = {
         path: File(path, "docs", "site", use_directory_urls) for path in existing_pages
     }
     plg.doc_pages["the/fake.md"].dest_path = "fake/destination/index.html"
     plg.doc_pages["the/fake.md"].url = plg.doc_pages["the/fake.md"]._get_url(use_directory_urls)
 
-    plg.on_post_build(dict(use_directory_urls=use_directory_urls, site_dir="site"))
+    config = dict(use_directory_urls=use_directory_urls, site_dir="site")
+    for entry in plg.doc_pages.values():
+        plg.on_page_content(None, Page(None, entry, config), config, None)
+    plg.on_post_build(config)
 
     return wrote