redirects for original URLs starting with #reference/...

Author: B4nan

apify-docs-theme/src/theme/DocSidebarItem/Link/index.jsx

@@ -31,6 +31,12 @@ export default function DocSidebarItemLink({
         props.target = '_self';
     }
 
+    if (item.customProps) {
+        for (const key of Object.keys(item.customProps)) {
+            props[`data-${key}`] = item.customProps[key];
+        }
+    }
+
     return (
         <li
             className={clsx(

apify-docs-theme/static/js/custom.js

@@ -84,8 +84,14 @@ function redirectOpenApiDocs() {
     }
 
     if (hash.startsWith('#/reference/')) {
-        const id = hash.substring('/#reference/'.length);
-        console.log('redirect', { id, hash });
+        const sidebarItems = document.querySelectorAll('[data-altids]');
+
+        for (const item of sidebarItems) {
+            const ids = item.getAttribute('data-altids').split(',');
+            if (ids.find((variant) => variant === hash)) {
+                item.click();
+            }
+        }
     }
 
     if (hash.startsWith('#tag/')) {
@@ -109,7 +115,7 @@ document.addEventListener('scroll', () => {
 });
 
 window.addEventListener('load', () => {
-    redirectOpenApiDocs();
+    setTimeout(() => redirectOpenApiDocs(), 500);
 
     // we need to wait a bit more, since the event fires too soon, and a lot of hydration is done after it
     setTimeout(() => scrollSidebarItemIntoView(), 1000);

docusaurus.config.js

@@ -1,5 +1,7 @@
 const { join } = require('node:path');
 
+const clsx = require('clsx');
+
 const { config } = require('./apify-docs-theme');
 const { collectSlugs } = require('./tools/utils/collectSlugs');
 const { externalLinkProcessor } = require('./tools/utils/externalLink');
@@ -190,6 +192,34 @@ module.exports = {
                             groupPathsBy: 'tag',
                             sidebarCollapsed: false,
                             sidebarCollapsible: false,
+                            sidebarGenerators: {
+                                createDocItem: (item, context) => {
+                                    const legacyUrls = item.api['x-legacy-doc-urls'] ?? [];
+                                    const altIds = legacyUrls.map((url) => {
+                                        const { hash } = new URL(url);
+                                        return hash;
+                                    });
+                                    const sidebarLabel = item.frontMatter.sidebar_label;
+                                    const { title } = item;
+                                    const id = item.type === 'schema' ? `schemas/${item.id}` : item.id;
+                                    const className = item.type === 'api'
+                                        ? clsx({
+                                            'menu__list-item--deprecated': item.api.deprecated,
+                                            'api-method': !!item.api.method,
+                                        }, item.api.method)
+                                        : clsx({
+                                            'menu__list-item--deprecated': item.schema.deprecated,
+                                        }, 'schema');
+
+                                    return {
+                                        type: 'doc',
+                                        id: context.basePath === '' ? `${id}` : `${context.basePath}/${id}`,
+                                        label: sidebarLabel ?? title ?? id,
+                                        customProps: { altIds },
+                                        className,
+                                    };
+                                },
+                            },
                         },
                     },
                 },