Fixed baseUrl error for search

Author: six-two

redirect.html

@@ -24,7 +24,7 @@ <h1>Demo listing pages</h1>
     <ul>
         <script>
             for (theme of ["mkdocs", "readthedocs", "material"]) {
-                document.write(`<li>${theme}: <a href="${theme}/plugin/listing-search.html">search page</a>, <a href="${theme}-no-dir/plugin/all-listings.html">all listings page</a></li>`)
+                document.write(`<li>${theme}: <a href="${theme}-no-dir/plugin/listing-search.html">search page</a>, <a href="${theme}-no-dir/plugin/all-listings.html">all listings page</a></li>`)
             }
         </script>
     </ul>

src/mkdocs_extract_listings_plugin/listing-search.js

@@ -13,37 +13,11 @@ STYLE=``;
 OFFLINE_JSON_DATA=null;
 // END
 
-let parentDirectoryUrl;
-if (document.currentScript && document.currentScript.src) {
-    // This is run when the script is included via an <script src=...> tag.
-    // The script is always at the same location, no matter on which page it is inluded.
-    parentDirectoryUrl = new URL(document.currentScript.src);
-    parentDirectoryUrl.pathname = parentDirectoryUrl.pathname.substring(0, parentDirectoryUrl.pathname.lastIndexOf("/") +  1);
-} else {
-    // This is run when the script is inlined to a page.
-    // In this case we can not be certain about where we are, but the python code fixed all relative paths, so that they should work from here.
-    parentDirectoryUrl = new URL(window.location.href);
-    const directoryUrlsUsed = parentDirectoryUrl.pathname.endsWith("/") || parentDirectoryUrl.pathname.endsWith("/index.html")
-    if (directoryUrlsUsed) {
-        // Directory URLs are in use -> go up one directory and remove file name
-        parentDirectoryUrl.pathname = parentDirectoryUrl.pathname.substring(0, parentDirectoryUrl.pathname.lastIndexOf("/"));
-        parentDirectoryUrl.pathname = parentDirectoryUrl.pathname.substring(0, parentDirectoryUrl.pathname.lastIndexOf("/") +  1);
-    } else {
-        // Directory URLs are disabled -> stay in directory but remove file name
-        parentDirectoryUrl.pathname = parentDirectoryUrl.pathname.substring(0, parentDirectoryUrl.pathname.lastIndexOf("/") +  1);
-    }
-}
-
-parentDirectoryUrl.query = "";
-parentDirectoryUrl.hash = "";
-const base_url = parentDirectoryUrl.href.endsWith("/") ? parentDirectoryUrl.href : parentDirectoryUrl.href + "/";
-console.debug("The base URL for the search result links is", base_url);
-
+// Convert relative to absolute URL
 const normalizeUrl = (url) => {
-    return new URL(url, location.href);
+    return new URL(url, location.href).pathname;
 };
 
-
 const parent = document.getElementById("listing-extract-search");
 if (parent) {
     const search_mode = parent.getAttribute("data-searchmode") || DEFAULT_SEARCH_MODE;
@@ -224,7 +198,7 @@ if (parent) {
     const on_json_loaded = (json) => {
         // Publicly accessible for easier debugging
         // Remap the URLs based on the location of this script (which is in the same directory as the JSON file)
-        window.extract_listings_case_sensitive = json.map(x => ({...x, page_url: normalizeUrl(base_url + x.page_url)}));
+        window.extract_listings_case_sensitive = json.map(x => ({...x, page_url: normalizeUrl(x.page_url)}));
         // @TODO: maybe only cache this if an cae-insensitive mode is selected?
         window.extract_listings_lowercase = window.extract_listings_case_sensitive.map(x => ({...x, text: x.text.toLowerCase()}));
 

src/mkdocs_extract_listings_plugin/search_page.py

@@ -20,22 +20,14 @@ def get_javascript_file_source_code(page_data_list: list[PageData], plugin_confi
 
     # We traverse from the JSON file up to the root directory
     path_to_root = "../" * script_or_page_path.count("/")
+    if config.use_directory_urls:
+        path_to_root += "../"
     if offline:
         json_data = get_json_data(page_data_list, path_to_root)
         js = js.replace("OFFLINE_JSON_DATA=null;", f"OFFLINE_JSON_DATA={json.dumps(json_data)};")
     else:
         write_json_file(page_data_list, plugin_config, config, path_to_root)
 
-    if config.site_url:
-        path = urlparse(config.site_url).path
-        # Remove trailing trashes
-        while path.endswith("/"):
-            path = path[:-1]
-
-        if path:
-            # Path contains something else than just slashes
-            js = js.replace('BASE_URL=""', f'BASE_URL="{path}"')
-
     return js
 
 

test-offline-build.sh

@@ -16,10 +16,15 @@ python3 -m pip install -r requirements.txt
 python3 -m pip install .
 
 # Do not use directory urls, since the browser does not map from /path/ to /path/index.html for file:// urls
-sed -e '/^use_directory_urls:/s|true|false|' -e '/offline:/s|false|true|' -e '/plugins:/a- offline' mkdocs.yml > "mkdocs-offline.yml"
+# use AWK instead of sed '/plugins:/a- offline' to make it work on macOS
+sed -e '/^use_directory_urls:/s|true|false|' -e '/offline:/s|false|true|' mkdocs.yml | awk '{print} /plugins:/ {print "- offline"}' > "mkdocs-offline.yml"
 
 echo "[*] Building site"
 python3 -m mkdocs build -f "mkdocs-offline.yml" || exit 1
 
 echo "[*] Opening path in firefox"
-firefox site/plugin/index.html
+if [[ $(uname) == Darwin ]]; then
+    open -a Firefox.app site/plugin/index.html
+else
+    firefox site/plugin/index.html
+fi