resolve conflict

Author: metalwarrior665

README.md

@@ -4,7 +4,7 @@
 
 ## Intro
 
-This repository is the home of Apify's documentation, which you can find at [docs.apify.com](https://docs.apify.com/). The documentation is written using [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). Source files of the [platform documentation](https://docs.apify.com/platform) are located in the [/sources](https://github.com/apify/apify-docs/tree/master/sources) directory. However, other sections, such as SDKs for [JavaScript/Node.js](https://docs.apify.com/sdk/js/), [Python](https://docs.apify.com/sdk/python/), or [CLI](https://docs.apify.com/cli), have their own repositories. For more information, see the [Contributing guidelines](./CONTRIBUTING.md).
+This repository is the home of Apify's documentation, which you can find at [docs.apify.com](https://docs.apify.com/). The documentation is written using [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). Source files of the [platform documentation](https://docs.apify.com/platform) are located in the [/sources](https://github.com/apify/apify-docs/tree/master/sources) directory. However, other sections, such as SDKs for [JavaScript/Node.js](https://docs.apify.com/sdk/js/), [Python](https://docs.apify.com/sdk/python/), or [CLI](https://docs.apify.com/cli/), have their own repositories. For more information, see the [Contributing guidelines](./CONTRIBUTING.md).
 
 ## Before you start contributing
 

_typos.toml

@@ -1,7 +1,7 @@
 [default]
 extend-ignore-re = [
-    '`[^`\n]+`',
-    '```[\s\S]*?```',
+    '`[^`\n]+`',  # skip inline code
+    '```[\s\S]*?```',  # skip code blocks
 ]
 
 [default.extend-words]

apify-docs-theme/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@apify/docs-theme",
-    "version": "1.0.134",
+    "version": "1.0.137",
     "description": "",
     "main": "./src/index.js",
     "files": [
@@ -19,7 +19,7 @@
         "access": "public"
     },
     "dependencies": {
-        "@apify/docs-search-modal": "^1.1.0",
+        "@apify/docs-search-modal": "^1.1.1",
         "@docusaurus/theme-common": "^3.5.2",
         "@stackql/docusaurus-plugin-hubspot": "^1.1.0",
         "axios": "^1.7.4",

apify-docs-theme/src/theme/MDXComponents/Details.js

@@ -6,7 +6,7 @@ export default function MDXDetails(props) {
     // Split summary item from the rest to pass it as a separate prop to the
     // Details theme component
     const summary = items.find(
-        (item) => React.isValidElement(item) && item.props?.mdxType === 'summary',
+        (item) => React.isValidElement(item) && item.type === 'summary',
     );
     const children = <>{items.filter((item) => item !== summary)}</>;
     return (

apify-docs-theme/src/theme/MDXComponents/index.js

@@ -17,7 +17,7 @@ const MDXComponents = {
     code: MDXCode,
     a: MDXA,
     pre: MDXPre,
-    details: MDXDetails,
+    Details: MDXDetails,
     ul: MDXUl,
     img: MDXImg,
     h1: (props) => <MDXHeading as="h1" {...props} />,

apify-docs-theme/src/theme/TOCItems/Tree.jsx

@@ -0,0 +1,41 @@
+import Link from '@docusaurus/Link';
+import clsx from 'clsx';
+import React from 'react';
+
+import styles from './styles.module.css';
+
+// Recursive component rendering the toc tree
+function TOCItemTree({
+    toc,
+    className,
+    linkClassName,
+    isChild,
+}) {
+    if (!toc.length) {
+        return null;
+    }
+    return (
+        <ul className={isChild ? undefined : className}>
+            {toc.map((heading) => (
+                <li key={heading.id}>
+                    <Link
+                        to={`#${heading.id}`}
+                        className={clsx(styles.apifyTocLink, linkClassName ?? undefined)}
+                        data-label={heading.value}
+                        // Developer provided the HTML, so assume it's safe.
+                        dangerouslySetInnerHTML={{ __html: heading.value }}
+                    />
+                    <TOCItemTree
+                        isChild
+                        toc={heading.children}
+                        className={className}
+                        linkClassName={linkClassName}
+                    />
+                </li>
+            ))}
+        </ul>
+    );
+}
+
+// Memo only the tree root is enough
+export default React.memo(TOCItemTree);

apify-docs-theme/src/theme/TOCItems/index.jsx

@@ -0,0 +1,50 @@
+import { useThemeConfig } from '@docusaurus/theme-common';
+import {
+    useTOCHighlight,
+    useFilteredAndTreeifiedTOC,
+} from '@docusaurus/theme-common/internal';
+import TOCItemTree from '@theme/TOCItems/Tree';
+import React, { useMemo } from 'react';
+
+export default function TOCItems({
+    toc,
+    className = 'table-of-contents table-of-contents__left-border',
+    linkClassName = 'table-of-contents__link',
+    linkActiveClassName = undefined,
+    minHeadingLevel: minHeadingLevelOption,
+    maxHeadingLevel: maxHeadingLevelOption,
+    ...props
+}) {
+    const themeConfig = useThemeConfig();
+
+    const minHeadingLevel = minHeadingLevelOption ?? themeConfig.tableOfContents.minHeadingLevel;
+    const maxHeadingLevel = maxHeadingLevelOption ?? themeConfig.tableOfContents.maxHeadingLevel;
+
+    const tocTree = useFilteredAndTreeifiedTOC({
+        toc,
+        minHeadingLevel,
+        maxHeadingLevel,
+    });
+
+    const tocHighlightConfig = useMemo(() => {
+        if (linkClassName && linkActiveClassName) {
+            return {
+                linkClassName,
+                linkActiveClassName,
+                minHeadingLevel,
+                maxHeadingLevel,
+            };
+        }
+        return undefined;
+    }, [linkClassName, linkActiveClassName, minHeadingLevel, maxHeadingLevel]);
+    useTOCHighlight(tocHighlightConfig);
+
+    return (
+        <TOCItemTree
+            toc={tocTree}
+            className={className}
+            linkClassName={linkClassName}
+            {...props}
+        />
+    );
+}

apify-docs-theme/src/theme/TOCItems/styles.module.css

@@ -0,0 +1,12 @@
+.apifyTocLink {
+    display: block;
+}
+
+.apifyTocLink::before {
+    display: block;
+    content: attr(data-label);
+    font-weight: 700;
+    height: 0;
+    overflow: hidden;
+    visibility: hidden;
+}

apify-docs-theme/src/theme/custom.css

@@ -1549,6 +1549,7 @@ html[data-theme='dark'] .runnable-code-block svg .apify-logo {
 .prism-code.language-javascript .token-line::before,
 .prism-code.language-json .token-line::before,
 .prism-code.language-json5 .token-line::before,
+.prism-code.language-py .token-line::before,
 .prism-code.language-python .token-line::before,
 .prism-code.language-dockerfile .token-line::before,
 .prism-code.language-XML .token-line::before,

clientModule.js

@@ -0,0 +1,13 @@
+// client module for callbacks on route change
+// see https://docusaurus.io/docs/advanced/client#client-module-lifecycles
+export function onRouteDidUpdate({ location, previousLocation }) {
+    // Don't execute if we are still on the same page; the lifecycle may be fired
+    // because the hash changes (e.g. when navigating between headings)
+    if (location.pathname !== previousLocation?.pathname) {
+        // hubspot tracking page view
+        // eslint-disable-next-line no-underscore-dangle, no-multi-assign
+        const _hsq = window._hsq = window._hsq || [];
+        _hsq.push(['setPath', window.location.pathname]);
+        _hsq.push(['trackPageView']);
+    }
+}