Merge branch 'master' into chore/throw-on-broken-anchors

Author: TC-MO

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,8 @@
 [default]
 extend-ignore-re = [
-    '`[^`\n]+`',
-    '```[\s\S]*?```',
+    '`[^`\n]+`',  # skip inline code
+    '```[\s\S]*?```',  # skip code blocks
+    'Bún bò Nam Bô',  # otherwise "Nam" is considered as a typo of "Name"
 ]
 
 [default.extend-words]

apify-docs-theme/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@apify/docs-theme",
-    "version": "1.0.135",
+    "version": "1.0.137",
     "description": "",
     "main": "./src/index.js",
     "files": [

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/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']);
+    }
+}

docusaurus.config.js

@@ -195,12 +195,12 @@ module.exports = {
         mermaid: true,
         parseFrontMatter: async (params) => {
             const result = await params.defaultParseFrontMatter(params);
-
-            const ogImageURL = new URL('https://apify.com/og-image/docs-article');
-
-            ogImageURL.searchParams.set('title', result.frontMatter.title);
-            result.frontMatter.image ??= ogImageURL.toString();
-
+            const isPartial = params.filePath.split('/').pop()[0] === '_';
+            if (!isPartial) {
+                const ogImageURL = new URL('https://apify.com/og-image/docs-article');
+                ogImageURL.searchParams.set('title', result.frontMatter.title);
+                result.frontMatter.image ??= ogImageURL.toString();
+            }
             return result;
         },
     },
@@ -212,4 +212,5 @@ module.exports = {
             '^/legal/*',
         ],
     },
+    clientModules: ['./clientModule.js'],
 };