@apify/docs-theme 1.0.211 → 1.0.213

package/package.json

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

package/src/theme/DocItemContent/index.js

@@ -7,6 +7,8 @@ import MDXContent from '@theme/MDXContent';
 import clsx from 'clsx';
 import React from 'react';
 
+import styles from './styles.module.css';
+
 function useSyntheticTitle() {
   const { metadata, frontMatter, contentTitle } = useDoc();
   const shouldRender = !frontMatter.hide_title && typeof contentTitle === 'undefined';
@@ -62,11 +64,15 @@ export default function DocItemContent({ children }) {
   const shouldShowLLMButtons = allowedPaths.some((path) => location.pathname.startsWith(path))
     && !disallowedPaths.some((path) => location.pathname.includes(path));
 
-  return (
-    <div className={clsx(ThemeClassNames.docs.docMarkdown, 'markdown')}>
-      {syntheticTitle && <Heading as="h1">{syntheticTitle}</Heading>}
-      {shouldShowLLMButtons && <LLMButtons />}
-      <MDXContent>{children}</MDXContent>
-    </div>
-  );
+    return (
+        <div className={clsx(ThemeClassNames.docs.docMarkdown, 'markdown')}>
+            {(syntheticTitle || shouldShowLLMButtons) && (
+                <div className={styles.docItemContent}>
+                    {syntheticTitle && <Heading as="h1">{syntheticTitle}</Heading>}
+                    {shouldShowLLMButtons && <LLMButtons />}
+                </div>
+            )}
+            <MDXContent>{children}</MDXContent>
+        </div>
+    );
 }

package/src/theme/DocItemContent/styles.module.css

@@ -0,0 +1,17 @@
+.docItemContent {
+    display: flex;
+    align-items: center;
+    flex-wrap: wrap;
+    /* move the h1 margin to padding */
+    h1 {
+        margin-bottom: 0 !important;
+    }
+    padding-bottom: calc(
+        var(--ifm-h1-vertical-rhythm-bottom) * var(--ifm-leading)
+    );
+
+    @media (max-width: 767px) {
+        flex-direction: column;
+        align-items: flex-start;
+    }
+}

package/src/theme/LLMButtons/index.jsx

@@ -1,15 +1,295 @@
-import React from 'react';
+import clsx from 'clsx';
+import React, { useCallback, useState } from 'react';
+
+import {
+    AnthropicIcon,
+    ChatGptIcon,
+    CheckIcon,
+    ChevronDownIcon,
+    CopyIcon,
+    ExternalLinkIcon,
+    LoaderIcon,
+    MarkdownIcon,
+    PerplexityIcon,
+} from '@apify/ui-icons';
+import { Menu, Text, theme } from '@apify/ui-library';
 
-import CopyForLLM from './CopyForLLM';
 import styles from './styles.module.css';
-import ViewAsMarkdown from './ViewAsMarkdown';
 
-export default function LLMButtons() {
-    return (
-        <div className={styles.llmButtonsContainer}>
-            <ViewAsMarkdown />
-            <div className={styles.llmButtonsSeparator}></div>
-            <CopyForLLM />
+const DROPDOWN_OPTIONS = [
+    {
+        label: 'Copy for LLM',
+        description: 'Copy page as Markdown for LLMs',
+        showExternalIcon: false,
+        Icon: CopyIcon,
+        value: 'copyForLLM',
+    },
+    {
+        label: 'View as Markdown',
+        description: 'View this page as plain text',
+        showExternalIcon: true,
+        Icon: MarkdownIcon,
+        value: 'viewAsMarkdown',
+    },
+    {
+        label: 'Open in ChatGPT',
+        description: 'Ask questions about this page',
+        showExternalIcon: true,
+        Icon: ChatGptIcon,
+        value: 'openInChatGPT',
+    },
+    {
+        label: 'Open in Claude',
+        description: 'Ask questions about this page',
+        showExternalIcon: true,
+        Icon: AnthropicIcon,
+        value: 'openInClaude',
+    },
+    {
+        label: 'Open in Perplexity',
+        description: 'Ask questions about this page',
+        showExternalIcon: true,
+        Icon: PerplexityIcon,
+        value: 'openInPerplexity',
+    },
+];
+
+const getPrompt = (currentUrl) => `Read from ${currentUrl} so I can ask questions about it.`;
+const getMarkdownUrl = (currentUrl) => `${currentUrl}.md`;
+
+const onOpenInChatGPTClick = () => {
+    if (window.analytics) {
+        window.analytics.track('Clicked', {
+            app: 'docs',
+            button_text: 'Open in ChatGPT',
+            element: 'llm-buttons.openInChatGPT',
+        });
+    }
+
+    const prompt = getPrompt(window.location.href);
+
+    try {
+        window.open(
+            `https://chatgpt.com/?hints=search&q=${encodeURIComponent(prompt)}`,
+            '_blank',
+        );
+    } catch (error) {
+        console.error('Error opening ChatGPT:', error);
+    }
+};
+
+const onOpenInClaudeClick = () => {
+    if (window.analytics) {
+        window.analytics.track('Clicked', {
+            app: 'docs',
+            button_text: 'Open in Claude',
+            element: 'llm-buttons.openInClaude',
+        });
+    }
+
+    const prompt = getPrompt(window.location.href);
+
+    try {
+        window.open(
+            `https://claude.ai/new?q=${encodeURIComponent(prompt)}`,
+            '_blank',
+        );
+    } catch (error) {
+        console.error('Error opening Claude:', error);
+    }
+};
+
+const onOpenInPerplexityClick = () => {
+    if (window.analytics) {
+        window.analytics.track('Clicked', {
+            app: 'docs',
+            button_text: 'Open in Perplexity',
+            element: 'llm-buttons.openInPerplexity',
+        });
+    }
+
+    const prompt = getPrompt(window.location.href);
+
+    try {
+        window.open(
+            `https://www.perplexity.ai/search/new?q=${encodeURIComponent(
+                prompt,
+            )}`,
+            '_blank',
+        );
+    } catch (error) {
+        console.error('Error opening Perplexity:', error);
+    }
+};
+
+const onCopyAsMarkdownClick = async ({ setCopyingStatus }) => {
+    if (window.analytics) {
+        window.analytics.track('Clicked', {
+            app: 'docs',
+            button_text: 'Copy for LLM',
+            element: 'llm-buttons.copyForLLM',
+        });
+    }
+
+    const markdownUrl = getMarkdownUrl(window.location.href);
+
+    try {
+        setCopyingStatus('loading');
+
+        // Fetch the markdown content
+        const response = await fetch(markdownUrl);
+
+        if (!response.ok) {
+            throw new Error(`Failed to fetch markdown: ${response.status}`);
+        }
+
+        const markdownContent = await response.text();
+
+        // Copy to clipboard
+        await navigator.clipboard.writeText(markdownContent);
+
+        // Show success feedback
+        setCopyingStatus('copied');
+    } catch (error) {
+        console.error('Failed to copy markdown content:', error);
+    } finally {
+        setTimeout(() => setCopyingStatus('idle'), 2000);
+    }
+};
+
+const onViewAsMarkdownClick = () => {
+    if (window.analytics) {
+        window.analytics.track('Clicked', {
+            app: 'docs',
+            button_text: 'View as Markdown',
+            element: 'llm-buttons.viewAsMarkdown',
+        });
+    }
+
+    const markdownUrl = getMarkdownUrl(window.location.href);
+
+    try {
+        window.open(markdownUrl, '_blank');
+    } catch (error) {
+        console.error('Error opening markdown file:', error);
+    }
+};
+
+function getButtonText({ status }) {
+    switch (status) {
+        case 'loading':
+            return 'Copying...';
+        case 'copied':
+            return 'Copied';
+        default:
+            return 'Copy for LLM';
+    }
+}
+
+const MenuBase = ({
+    children,
+    ref,
+    copyingStatus,
+    setCopyingStatus,
+    chevronIconRef,
+    ...props
+}) => (
+    <div ref={ref} className={styles.llmButtonWrapper}>
+        <div className={styles.llmButton}>
+            <div
+                className={styles.copyUpIconWrapper}
+                onClick={() => onCopyAsMarkdownClick({ setCopyingStatus })}
+            >
+                {copyingStatus === 'loading' && <LoaderIcon size={16} />}
+                {copyingStatus === 'copied' && <CheckIcon size={16} />}
+                {copyingStatus === 'idle' && <CopyIcon size={16} />}
+            </div>
+            <Text
+                size="regular"
+                onClick={() => onCopyAsMarkdownClick({ setCopyingStatus })}
+                className={styles.llmButtonText}
+            >
+                {getButtonText({ status: copyingStatus })}
+            </Text>
+            <div {...props} className={styles.chevronIconWrapper}>
+                <ChevronDownIcon
+                    size="16"
+                    color={theme.color.neutral.icon}
+                    className={styles.chevronIcon}
+                    ref={chevronIconRef}
+                />
+            </div>
+        </div>
+    </div>
+);
+
+const Option = ({ Icon, label, description, showExternalIcon }) => (
+    <div className={styles.menuOption}>
+        <Icon size={16} className={styles.menuOptionIcon} />
+        <div className={styles.menuOptionText}>
+            <Text size="regular">{label}</Text>
+            <Text size="small" color={theme.color.neutral.textSubtle}>
+                {description}
+            </Text>
         </div>
+        {showExternalIcon && (
+            <ExternalLinkIcon
+                size={16}
+                className={styles.menuOptionExternalIcon}
+            />
+        )}
+    </div>
+);
+
+export default function LLMButtons({ isApiReferencePage = false }) {
+    const [copyingStatus, setCopyingStatus] = useState('idle');
+    const chevronIconRef = React.useRef(null);
+
+    const onMenuOptionClick = useCallback((value) => {
+        switch (value) {
+            case 'copyForLLM':
+                onCopyAsMarkdownClick({ setCopyingStatus });
+                break;
+            case 'viewAsMarkdown':
+                onViewAsMarkdownClick();
+                break;
+            case 'openInChatGPT':
+                onOpenInChatGPTClick();
+                break;
+            case 'openInClaude':
+                onOpenInClaudeClick();
+                break;
+            case 'openInPerplexity':
+                onOpenInPerplexityClick();
+                break;
+            default:
+                break;
+        }
+    }, []);
+
+    return (
+        <Menu
+            className={clsx(styles.llmMenu, {
+                [styles.llmMenuApiReferencePage]: isApiReferencePage,
+            })}
+            onMenuOpen={(isOpen) => chevronIconRef.current?.classList.toggle(
+                    styles.chevronIconOpen,
+                    isOpen,
+                )
+            }
+            components={{
+                MenuBase: (props) => (
+                    <MenuBase
+                        copyingStatus={copyingStatus}
+                        setCopyingStatus={setCopyingStatus}
+                        chevronIconRef={chevronIconRef}
+                        {...props}
+                    />
+                ),
+            }}
+            onSelect={onMenuOptionClick}
+            options={DROPDOWN_OPTIONS}
+            renderOption={Option}
+        />
     );
 }

package/src/theme/LLMButtons/styles.module.css

@@ -1,57 +1,115 @@
-.llmButtonsContainer {
+:global .menu-list[data-floating-ui-focusable] {
+    gap: 0.4rem;
+    padding: 0.6rem;
+}
+
+.llmMenu {
+    margin-top: 1.2rem;
+    width: fit-content;
+
+    @media (min-width: 768px) {
+        margin-left: auto;
+    }
+}
+
+.llmButtonWrapper {
     display: flex;
-    align-items: center;
-    gap: 12px;
-    margin-top: -8px;
-    margin-bottom: calc(var(--ifm-h1-vertical-rhythm-bottom) * var(--ifm-leading));
+    justify-content: flex-end;
+
+    @media (min-width: 768px) {
+        /* hack to make the dropdown menu align to the right */
+        width: 23.3rem;
+    }
 }
 
-.llmButtonsSeparator {
-    width: 1px;
-    height: 16px;
-    background-color: var(--ifm-hr-background-color);
+.llmMenuApiReferencePage {
+    margin-top: -0.8rem;
+    margin-bottom: calc(var(--ifm-h1-vertical-rhythm-bottom) * var(--ifm-leading));
+    margin-left: 0 !important;
+    .llmButtonWrapper {
+        width: fit-content !important;
+    }
 }
 
 .llmButton {
+    width: fit-content;
+    display: inline-flex;
+    align-items: center;
+    height: 3rem;
+
     display: flex;
     align-items: center;
-    background-color: transparent;
-    border: none;
-    height: 16px;
+    border-radius: 8px;
+    border: 1px solid var(--color-Neutral_SeparatorSubtle);
+    background-color: var(--color-Neutral_BackgroundMuted);
+
     cursor: pointer;
-    padding: 0;
-    gap: 4px;
+    transition: background-color 0.2s ease-in-out;
+
+    &:hover {
+        background-color: var(--color-Neutral_BackgroundMuted);
+    }
 }
 
-.llmButtonIcon {
-    width: 16px;
-    height: 16px;
-    margin: 0 !important;
-    cursor: pointer;
-    background-size: contain;
-    background-repeat: no-repeat;
-    background-position: center;
-    display: inline-block;
+.copyUpIconWrapper {
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    padding-left: 0.8rem;
+    padding-right: 0.4rem;
+    height: 100%;
+}
+
+.llmButtonText {
+    height: 100%;
+    display: flex;
+    align-items: center;
+    padding-right: 0.8rem;
+    min-width: 9.3rem;
+
+    /* prevents font size glitch when loading the page */
+    margin: 0px;
+    font-size: 1.4rem;
+    font-weight: 400;
+    font-family: Inter, sans-serif;
 }
 
-.llmButtonIconBackgroundMarkdown {
-    background-image: url('https://docs.apify.com/img/markdown.svg');
+.chevronIconWrapper {
+    border-left: 1px solid var(--color-Neutral_SeparatorSubtle);
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    padding-inline: 0.8rem;
+    height: 100%;
+}
 
+.chevronIcon {
+    transition: transform 0.2s ease-in-out;
 }
 
-.llmButtonIconBackgroundCopy {
-    background-image: url('https://docs.apify.com/img/copy.svg');
+.chevronIconOpen {
+    transform: rotate(180deg);
 }
 
-/* Dark theme adjustments */
-[data-theme='dark'] .llmButtonIcon {
-    color: #e0e0e0;
+.menuOption {
+    padding-block: 0.4rem;
+    display: flex;
+    gap: 0.4rem;
 }
 
-[data-theme='dark'] .llmButtonIconBackgroundMarkdown {
-    background-image: url('https://docs.apify.com/img/markdown-dark-theme.svg');
+.menuOptionIcon {
+    flex-shrink: 0;
+    margin-top: 0.4rem;
+}
+
+.menuOptionText {
+    flex: 1;
+    display: flex;
+    flex-direction: column;
+    gap: 0.2rem;
 }
 
-[data-theme='dark'] .llmButtonIconBackgroundCopy {
-    background-image: url('https://docs.apify.com/img/copy-dark-theme.svg');
+.menuOptionExternalIcon {
+    flex-shrink: 0;
+    margin-top: 0.2rem;
 }

package/src/theme/custom.css

@@ -1740,18 +1740,6 @@ html[data-theme='dark'] .runnable-code-block svg .apify-logo {
 
 }
 
-.redocusaurus table code {
-    word-break: normal;
-}
-
-.redocusaurus .menu-content div:nth-child(2) ul {
-    padding-bottom: 0;
-}
-
-.redocusaurus .menu-content div:nth-child(2) div {
-    display: none;
-}
-
 .apiPage .tsd-panel-header .tsd-anchor-id {
     top: -13rem;
 }
@@ -1763,44 +1751,40 @@ iframe[src*="youtube"] {
     margin-bottom: 1.6rem;
 }
 
-.redocusaurus div[data-section-id] span[id] {
-    margin-top: -130px;
-    position: absolute;
-}
-
-.redocusaurus .openapi-clients-box {
+.theme-api-markdown .openapi-clients-box {
     display: block;
     float: right;
-    padding-left: 6px;
+    padding-left: 12px;
+    padding-right: 6px;
 }
 
-.redocusaurus .openapi-clients-box-heading {
-    display: inline-block;
-    font-family: 'San Francisco', Helvetica, Arial, sans-serif;
-    color: #6C7590;
-    font-style: normal;
-    font-weight: 700;
-    font-size: 14px;
-    line-height: 20px;
-    text-transform: uppercase;
-    padding-bottom: 6px;
+.client-docs-link img {
+    border: 1px solid var(--color-neutral-action-secondary);
+    border-radius: 8px;
 }
 
-.redocusaurus .openapi-clients-box-icon {
-    display: block;
-    padding-bottom: 6px;
+.client-docs-link {
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    justify-content: left;
+    gap: 8px;
+    padding: 4px 8px 8px 0px;
 }
 
-.theme-api-markdown .openapi-clients-box {
-    display: block;
-    float: right;
-    padding-left: 6px;
+a.client-docs-link {
+    font-weight: 500;
+    color: var(--color-neutral-text-muted);
+}
+
+.theme-admonition {
+    clear: right;
 }
 
 .theme-api-markdown .openapi-clients-box-heading {
     display: inline-block;
     font-family: 'San Francisco', Helvetica, Arial, sans-serif;
-    color: #6C7590;
+    color: var(--color-neutral-text-muted);
     font-style: normal;
     font-weight: 700;
     font-size: 14px;
@@ -1811,7 +1795,7 @@ iframe[src*="youtube"] {
 
 .theme-api-markdown .openapi-clients-box-icon {
     display: block;
-    padding-bottom: 6px;
+    padding: 2px;
     margin: 0 !important;
 }
 

package/src/theme/LLMButtons/CopyForLLM/index.jsx

@@ -1,71 +0,0 @@
-import React, { useState } from 'react';
-
-import styles from '../styles.module.css';
-
-// Custom component for button text
-function ButtonText({ isLoading, isCopied }) {
-    if (isLoading) {
-        return 'Copying...';
-    }
-    if (isCopied) {
-        return 'Copied!';
-    }
-    return 'Copy for LLM';
-}
-
-export default function CopyForLLM() {
-    const [isLoading, setIsLoading] = useState(false);
-    const [isCopied, setIsCopied] = useState(false);
-
-    const handleCopy = async () => {
-        if (window.analytics) {
-            window.analytics.track('Clicked', {
-                app: 'docs',
-                button_text: 'Copy for LLM',
-                element: 'llm-buttons.copyForLLM',
-            });
-        }
-
-        try {
-            setIsLoading(true);
-
-            const currentUrl = window.location.href;
-            const markdownUrl = `${currentUrl}.md`;
-
-            // Fetch the markdown content
-            const response = await fetch(markdownUrl);
-
-            if (!response.ok) {
-                throw new Error(`Failed to fetch markdown: ${response.status}`);
-            }
-
-            const markdownContent = await response.text();
-
-            // Copy to clipboard
-            await navigator.clipboard.writeText(markdownContent);
-
-            // Show success feedback
-            setIsCopied(true);
-            setTimeout(() => setIsCopied(false), 2000);
-        } catch (error) {
-            console.error('Failed to copy markdown content:', error);
-        } finally {
-            setIsLoading(false);
-        }
-    };
-
-    return (
-        <button
-            className={styles.llmButton}
-            title="Copy for LLM"
-            onClick={handleCopy}
-            disabled={isLoading}
-        >
-            <span
-                className={`${styles.llmButtonIcon} ${styles.llmButtonIconBackgroundCopy}`}
-                aria-label="Copy for LLM"
-            />
-            <ButtonText isLoading={isLoading} isCopied={isCopied} />
-        </button>
-    );
-}

package/src/theme/LLMButtons/ViewAsMarkdown/index.jsx

@@ -1,37 +0,0 @@
-import React from 'react';
-
-import styles from '../styles.module.css';
-
-export default function ViewAsMarkdown() {
-    const handleClick = () => {
-        if (window.analytics) {
-            window.analytics.track('Clicked', {
-                app: 'docs',
-                button_text: 'View as Markdown',
-                element: 'llm-buttons.viewAsMarkdown',
-            });
-        }
-
-        try {
-            const currentUrl = window.location.href;
-            const markdownUrl = `${currentUrl}.md`;
-            window.open(markdownUrl, '_blank');
-        } catch (error) {
-            console.error('Error opening markdown file:', error);
-        }
-    };
-
-    return (
-        <button
-            className={styles.llmButton}
-            title="View as Markdown"
-            onClick={handleClick}
-        >
-            <span
-                className={`${styles.llmButtonIcon} ${styles.llmButtonIconBackgroundMarkdown}`}
-                aria-label="View as Markdown"
-            />
-            View as Markdown
-        </button>
-    );
-}