@apify/docs-theme 1.0.59 → 1.0.61

package/package.json

@@ -1,24 +1,32 @@
 {
-  "name": "@apify/docs-theme",
-  "version": "1.0.59",
-  "description": "",
-  "main": "./src/index.js",
-  "files": [
-    "src",
-    "types",
-    "static"
-  ],
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "echo 'Building @apify/docs-theme!'"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "@docusaurus/theme-common": "^2.2.0",
-    "axios": "^1.3.1",
-    "babel-loader": "^9.1.0",
-    "prism-react-renderer": "^1.3.5"
-  }
+    "name": "@apify/docs-theme",
+    "version": "1.0.61",
+    "description": "",
+    "main": "./src/index.js",
+    "files": [
+        "src",
+        "types",
+        "static"
+    ],
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1",
+        "build": "echo 'Building @apify/docs-theme!'"
+    },
+    "keywords": [],
+    "author": "",
+    "license": "ISC",
+    "publishConfig": {
+        "access": "public"
+    },
+    "dependencies": {
+        "@docusaurus/theme-common": "^2.3.1",
+        "axios": "^1.3.1",
+        "babel-loader": "^9.1.0",
+        "prism-react-renderer": "^1.3.5"
+    },
+    "peerDependencies": {
+        "@docsearch/react": "*",
+        "react": "*",
+        "react-dom": "*"
+    }
 }

package/src/config.js

@@ -1,3 +1,4 @@
+/* eslint-disable global-require */
 const absoluteUrl = process.env.LOCAL ? 'http://docs.apify.loc' : 'https://docs.apify.com';
 
 const themeConfig = ({
@@ -87,7 +88,7 @@ const themeConfig = ({
                 rel: 'dofollow',
             },
             {
-                label: 'Open Source',
+                label: 'Open source',
                 type: 'dropdown',
                 position: 'left',
                 className: 'navbar__item',
@@ -106,7 +107,7 @@ const themeConfig = ({
                         href: 'https://github.com/apify/fingerprint-suite',
                     },
                     {
-                        label: 'See our GitHub',
+                        label: 'See Apify on GitHub',
                         href: 'https://github.com/apify',
                     },
                 ],
@@ -114,7 +115,7 @@ const themeConfig = ({
             {
                 href: 'https://github.com/apify',
                 label: 'GitHub',
-                title: 'See our GitHub',
+                title: 'See Apify on GitHub',
                 position: 'right',
                 className: 'icon',
             },

package/src/theme/ColorModeToggle/index.jsx

@@ -9,7 +9,7 @@ import styles from './styles.module.css';
 function ColorModeToggle({
     className,
     value,
-    onChange
+    onChange,
 }) {
     const isBrowser = useIsBrowser();
     const title = translate(

package/src/theme/Footer/index.jsx

@@ -39,7 +39,9 @@ function Footer() {
                 </div>
                 <div className="row padding-vert--md padding-top--lg">
                     <div className="col padding-vert--md col--6">
-                        <div className={styles.footerLogo}></div>
+                        <a href="https://apify.com" target={'_blank'} rel={'dofollow noreferrer'}>
+                            <span className={styles.footerLogo}></span>
+                        </a>
                     </div>
                 </div>
             </div>

package/src/theme/Footer/index.module.css

@@ -45,6 +45,7 @@
 }
 
 .footerLogo {
+    display: inline-block;
     width: 90px;
     height: 24px;
     background-image: url('/img/footer-apify-logo-black.svg');
@@ -54,3 +55,5 @@
 html[data-theme='dark'] .footerLogo {
     background-image: url('/img/footer-apify-logo-white.svg');
 }
+
+/** dummy comment just to trigger theme publishing 2 */

package/src/theme/Icon/DarkMode/index.jsx

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 import React from 'react';
 
 function IconDarkMode(props) {

package/src/theme/Icon/LightMode/index.jsx

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 import React from 'react';
 
 function IconLightMode(props) {

package/src/theme/MDXComponents/A.js

@@ -0,0 +1,16 @@
+import React from 'react';
+import Link from '@docusaurus/Link';
+import { isDifferentInstance } from '../../utils';
+
+export default function MDXA(props) {
+    if (props.href && isDifferentInstance(props.href)) {
+        return <a {...props} onClick={((e) => {
+            e.preventDefault();
+            window.location.assign(props.href);
+        })}>
+            {props.children}
+        </a>;
+    }
+
+    return <Link {...props} />;
+}

package/src/theme/NavbarItem/NavbarNavLink.jsx

@@ -80,6 +80,7 @@ export default function NavbarNavLink({
             to={toUrl}
             isNavLink
             {...((activeBasePath || activeBaseRegex) && {
+                // eslint-disable-next-line no-shadow
                 isActive: (_match, location) => (activeBaseRegex
                     ? isRegexpStringMatch(activeBaseRegex, location.pathname) || dropDownHasActiveItem
                     : location.pathname.startsWith(activeBaseUrl)),

package/src/theme/SearchBar/index.js

@@ -0,0 +1,192 @@
+/* eslint-disable operator-linebreak,import/no-extraneous-dependencies */
+import React, { useCallback, useMemo, useRef, useState } from 'react';
+import { DocSearchButton, useDocSearchKeyboardEvents } from '@docsearch/react';
+import Head from '@docusaurus/Head';
+import Link from '@docusaurus/Link';
+import { useSearchPage } from '@docusaurus/theme-common/internal';
+import {
+    useAlgoliaContextualFacetFilters,
+    useSearchResultUrlProcessor,
+} from '@docusaurus/theme-search-algolia/client';
+import Translate from '@docusaurus/Translate';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import { createPortal } from 'react-dom';
+import translations from '@theme/SearchTranslations';
+
+let DocSearchModal = null;
+
+function A(props) {
+    return <Link {...props} onClick={((e) => {
+        e.preventDefault();
+        window.location.assign(props.href || props.to);
+    })}>
+        {props.children}
+    </Link>;
+}
+
+function Hit({ hit, children }) {
+    return <A to={hit.url}>{children}</A>;
+}
+
+function ResultsFooter({ state, onClose }) {
+    const { generateSearchPageLink } = useSearchPage();
+    return (
+        <A to={generateSearchPageLink(state.query)} onClick={onClose}>
+            <Translate
+                id="theme.SearchBar.seeAll"
+                values={{ count: state.context.nbHits }}>
+                {'See all {count} results'}
+            </Translate>
+        </A>
+    );
+}
+
+function mergeFacetFilters(f1, f2) {
+    const normalize = (f) => (typeof f === 'string' ? [f] : f);
+    return [...normalize(f1), ...normalize(f2)];
+}
+
+function DocSearch({ contextualSearch, externalUrlRegex, ...props }) {
+    const { siteMetadata } = useDocusaurusContext();
+    const processSearchResultUrl = useSearchResultUrlProcessor();
+    const contextualSearchFacetFilters = useAlgoliaContextualFacetFilters();
+    const configFacetFilters = props.searchParameters?.facetFilters ?? [];
+    const facetFilters = contextualSearch
+        ? // Merge contextual search filters with config filters
+        mergeFacetFilters(contextualSearchFacetFilters, configFacetFilters)
+        : // ... or use config facetFilters
+        configFacetFilters;
+    // We let user override default searchParameters if she wants to
+    const searchParameters = {
+        ...props.searchParameters,
+        facetFilters,
+    };
+    const searchContainer = useRef(null);
+    const searchButtonRef = useRef(null);
+    const [isOpen, setIsOpen] = useState(false);
+    const [initialQuery, setInitialQuery] = useState(undefined);
+    const importDocSearchModalIfNeeded = useCallback(() => {
+        if (DocSearchModal) {
+            return Promise.resolve();
+        }
+        return Promise.all([
+            import('@docsearch/react/modal'),
+            import('@docsearch/react/style'),
+            import('./styles.css'),
+        ]).then(([{ DocSearchModal: Modal }]) => {
+            DocSearchModal = Modal;
+        });
+    }, []);
+    const onOpen = useCallback(() => {
+        importDocSearchModalIfNeeded().then(() => {
+            searchContainer.current = document.createElement('div');
+            document.body.insertBefore(
+                searchContainer.current,
+                document.body.firstChild,
+            );
+            setIsOpen(true);
+        });
+    }, [importDocSearchModalIfNeeded, setIsOpen]);
+    const onClose = useCallback(() => {
+        setIsOpen(false);
+        searchContainer.current?.remove();
+    }, [setIsOpen]);
+    const onInput = useCallback(
+        (event) => {
+            importDocSearchModalIfNeeded().then(() => {
+                setIsOpen(true);
+                setInitialQuery(event.key);
+            });
+        },
+        [importDocSearchModalIfNeeded, setIsOpen, setInitialQuery],
+    );
+    const navigator = useRef({
+        navigate({ itemUrl }) {
+            window.location.href = itemUrl;
+        },
+    }).current;
+    const { siteConfig } = useDocusaurusContext();
+    const transformItems = useRef((items) => (props.transformItems
+        ? // Custom transformItems
+        props.transformItems(items)
+        : // Default transformItems
+        items.map((item) => ({
+            ...item,
+            url: processSearchResultUrl(item.url).replace(new RegExp(`^${siteConfig.baseUrl}`), '/'),
+        }))),
+    ).current;
+    const resultsFooterComponent = useMemo(
+        () =>
+            // eslint-disable-next-line react/no-unstable-nested-components,react/display-name,implicit-arrow-linebreak
+            (footerProps) => <ResultsFooter {...footerProps} onClose={onClose}/>,
+        [onClose],
+    );
+    const transformSearchClient = useCallback(
+        (searchClient) => {
+            searchClient.addAlgoliaAgent(
+                'docusaurus',
+                siteMetadata.docusaurusVersion,
+            );
+            return searchClient;
+        },
+        [siteMetadata.docusaurusVersion],
+    );
+    useDocSearchKeyboardEvents({
+        isOpen,
+        onOpen,
+        onClose,
+        onInput,
+        searchButtonRef,
+    });
+    return (
+        <>
+            <Head>
+                {/* This hints the browser that the website will load data from Algolia,
+        and allows it to preconnect to the DocSearch cluster. It makes the first
+        query faster, especially on mobile. */}
+                <link
+                    rel="preconnect"
+                    href={`https://${props.appId}-dsn.algolia.net`}
+                    crossOrigin="anonymous"
+                />
+            </Head>
+
+            <DocSearchButton
+                onTouchStart={importDocSearchModalIfNeeded}
+                onFocus={importDocSearchModalIfNeeded}
+                onMouseOver={importDocSearchModalIfNeeded}
+                onClick={onOpen}
+                ref={searchButtonRef}
+                translations={translations.button}
+            />
+
+            {isOpen
+                && DocSearchModal
+                && searchContainer.current
+                && createPortal(
+                    <DocSearchModal
+                        onClose={onClose}
+                        initialScrollY={window.scrollY}
+                        initialQuery={initialQuery}
+                        navigator={navigator}
+                        transformItems={transformItems}
+                        hitComponent={Hit}
+                        transformSearchClient={transformSearchClient}
+                        {...(props.searchPagePath && {
+                            resultsFooterComponent,
+                        })}
+                        {...props}
+                        searchParameters={searchParameters}
+                        placeholder={translations.placeholder}
+                        translations={translations.modal}
+                    />,
+                    searchContainer.current,
+                )}
+        </>
+    );
+}
+
+export default function SearchBar() {
+    const { siteConfig } = useDocusaurusContext();
+    return <DocSearch {...siteConfig.themeConfig.algolia} />;
+}

package/src/theme/SearchBar/styles.css

@@ -0,0 +1,14 @@
+:root {
+  --docsearch-primary-color: var(--ifm-color-primary);
+  --docsearch-text-color: var(--ifm-font-color-base);
+}
+
+.DocSearch-Button {
+  margin: 0;
+  transition: all var(--ifm-transition-fast)
+    var(--ifm-transition-timing-default);
+}
+
+.DocSearch-Container {
+  z-index: calc(var(--ifm-z-index-fixed) + 1);
+}

package/src/theme/custom.css

@@ -394,7 +394,7 @@ html.plugin-docs .theme-doc-markdown {
 
 html.plugin-docs .theme-doc-markdown img {
     display: block;
-    margin: 0 auto;
+    margin: 1em auto 2em;
 }
 
 html.plugin-docs .theme-doc-markdown h1 {
@@ -536,7 +536,6 @@ div[class*="searchBox"] {
     align-items: center;
 }
 
-
 @media (min-width: 480px) {
     .navbar__logo {
         display: initial;

package/src/theme.js

@@ -85,7 +85,7 @@ function theme(
 title: Changelog
 sidebar_label: Changelog
 ---
-It seems that the changelog is not available. 
+It seems that the changelog is not available.
 This either means that your Docusaurus setup is misconfigured, or that your GitHub repository contains no releases yet.
 `);
                 }
@@ -96,6 +96,7 @@ This either means that your Docusaurus setup is misconfigured, or that your GitH
                     await copyChangelogFromReleases(pathsToCopyChangelog, `${context.siteConfig.organizationName}/${context.siteConfig.projectName}`);
                 }
             } catch (e) {
+                // eslint-disable-next-line no-console
                 console.warn(`Changelog page could not be initialized: ${e.message}`);
             }
         },

package/src/utils.js

@@ -0,0 +1,14 @@
+/**
+ * @param {string} input
+ */
+export function isDifferentInstance(input) {
+    const simplified = input.startsWith('/') ? input.slice(1) : input;
+
+    const instanceUrls = [
+        'api/client',
+        'sdk',
+        'cli',
+    ];
+
+    return instanceUrls.some((url) => simplified.startsWith(url));
+}

package/types/index.js

@@ -1,12 +0,0 @@
-/**
- * @typedef {{
- *      subNavbar: {
- *          title: string,
- *          items: any[]
- *      }
- * }} ThemeOptions
-*/
-
-module.exports = {
-    types: {},
-};