Skip to content

Commit f6eaf37

Browse files
adithyaakrishnaadithyaakrishna
committed
chore: add md popovers
1 parent 98557ad commit f6eaf37

File tree

6 files changed

+375
-6
lines changed

6 files changed

+375
-6
lines changed

‎apps/docs/app/[lang]/[[...slug]]/page.tsx‎

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import { existsSync } from 'node:fs'
2+
import { join, relative } from 'node:path'
13
import type React from 'react'
24
import type { Root } from 'fumadocs-core/page-tree'
35
import { findNeighbour } from 'fumadocs-core/page-tree'
@@ -11,17 +13,41 @@ import Link from 'next/link'
1113
import { notFound } from 'next/navigation'
1214
import { PageNavigationArrows } from '@/components/docs-layout/page-navigation-arrows'
1315
import { TOCFooter } from '@/components/docs-layout/toc-footer'
14-
import { LLMCopyButton } from '@/components/page-actions'
1516
import { StructuredData } from '@/components/structured-data'
1617
import { CodeBlock } from '@/components/ui/code-block'
1718
import { Heading } from '@/components/ui/heading'
1819
import { ResponseSection } from '@/components/ui/response-section'
1920
import { i18n } from '@/lib/i18n'
2021
import { getApiSpecContent, openapi } from '@/lib/openapi'
2122
import { type PageData, source } from '@/lib/source'
23+
import { LLMCopyButton, ViewOptionsPopover } from '@/components/page-actions'
2224

2325
const SUPPORTED_LANGUAGES: Set<string> = new Set(i18n.languages)
2426
const BASE_URL = 'https://docs.sim.ai'
27+
const CONTENT_DOCS_DIR = join(process.cwd(), 'apps/docs/content/docs')
28+
29+
function resolveGitHubDocUrl(pageUrl: string) {
30+
const pathParts = pageUrl.split('/').filter(Boolean)
31+
if (pathParts.length === 0) return undefined
32+
33+
const first = pathParts[0] ?? ''
34+
const lang = SUPPORTED_LANGUAGES.has(first) ? first : i18n.defaultLanguage
35+
const restParts = SUPPORTED_LANGUAGES.has(first) ? pathParts.slice(1) : pathParts
36+
37+
const relBase = restParts.join('/')
38+
if (!relBase) return undefined
39+
40+
const candidates = [
41+
join(CONTENT_DOCS_DIR, lang, `${relBase}.mdx`),
42+
join(CONTENT_DOCS_DIR, lang, relBase, 'index.mdx'),
43+
]
44+
45+
const foundPath = candidates.find((p) => existsSync(p))
46+
if (!foundPath) return undefined
47+
48+
const relFromContent = relative(CONTENT_DOCS_DIR, foundPath).split('\\').join('/')
49+
return `https://github.com/simstudioai/sim/blob/main/apps/docs/content/docs/${relFromContent}`
50+
}
2551

2652
function resolveLangAndSlug(params: { slug?: string[]; lang: string }) {
2753
const isValidLang = SUPPORTED_LANGUAGES.has(params.lang)
@@ -67,6 +93,9 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
6793
const isOpenAPI = '_openapi' in data && data._openapi != null
6894
const isApiReference = slug?.some((s) => s === 'api-reference') ?? false
6995

96+
const markdownUrl = `${page.url}.mdx`
97+
const githubUrl = resolveGitHubDocUrl(page.url)
98+
7099
const pageTreeRecord = source.pageTree as Record<string, Root>
71100
const pageTree = pageTreeRecord[lang] ?? pageTreeRecord.en ?? Object.values(pageTreeRecord)[0]
72101
const rawNeighbours = pageTree ? findNeighbour(pageTree, page.url) : null
@@ -257,6 +286,11 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
257286
<div className='hidden sm:flex'>
258287
<LLMCopyButton content={apiPageContent} />
259288
</div>
289+
<div className='hidden sm:flex'>
290+
<ViewOptionsPopover markdownUrl={markdownUrl} githubUrl={githubUrl}>
291+
Open
292+
</ViewOptionsPopover>
293+
</div>
260294
<PageNavigationArrows previous={neighbours?.previous} next={neighbours?.next} />
261295
</div>
262296
<DocsTitle>{data.title}</DocsTitle>
@@ -271,7 +305,6 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
271305
}
272306

273307
const MDX = data.body
274-
const markdownContent = await data.getText('processed')
275308

276309
return (
277310
<>
@@ -306,8 +339,13 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
306339
<div className='relative mt-6 sm:mt-0'>
307340
<div className='absolute top-1 right-0 flex items-center gap-2'>
308341
<div className='hidden sm:flex'>
309-
<LLMCopyButton content={markdownContent} />
342+
<LLMCopyButton markdownUrl={markdownUrl} />
310343
</div>
344+
<div className='hidden sm:flex'>
345+
<ViewOptionsPopover markdownUrl={markdownUrl} githubUrl={githubUrl}>
346+
Open
347+
</ViewOptionsPopover>
348+
</div>
311349
<PageNavigationArrows previous={neighbours?.previous} next={neighbours?.next} />
312350
</div>
313351
<DocsTitle>{data.title}</DocsTitle>

‎apps/docs/components/ai/page-actions.tsx‎

Lines changed: 257 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,257 @@
1+
'use client'
2+
3+
import { type ComponentProps, useMemo, useState } from 'react';
4+
import { Check, ChevronDown, Copy, ExternalLinkIcon, TextIcon } from 'lucide-react';
5+
import { cn } from '@/lib/utils'
6+
import { useCopyButton } from 'fumadocs-ui/utils/use-copy-button';
7+
import { Popover, PopoverTrigger, PopoverContent } from '@/components/ui/popover'
8+
import { buttonVariants } from '@/components/ui/button'
9+
import { usePathname } from 'fumadocs-core/framework'
10+
11+
const cache = new Map<string, Promise<string>>();
12+
13+
/**
14+
* see https://fumadocs.dev/docs/integrations/llms#page-actions to customise.
15+
*/
16+
export function MarkdownCopyButton({
17+
markdownUrl,
18+
...props
19+
}: ComponentProps<'button'> & {
20+
/**
21+
* A URL to fetch the raw Markdown/MDX content of page
22+
*/
23+
markdownUrl: string;
24+
}) {
25+
const [isLoading, setLoading] = useState(false);
26+
const [checked, onClick] = useCopyButton(async () => {
27+
const cached = cache.get(markdownUrl);
28+
if (cached) return navigator.clipboard.writeText(await cached);
29+
30+
setLoading(true);
31+
32+
try {
33+
const promise = fetch(markdownUrl).then((res) => res.text());
34+
cache.set(markdownUrl, promise);
35+
await navigator.clipboard.write([
36+
new ClipboardItem({
37+
'text/plain': promise,
38+
}),
39+
]);
40+
} finally {
41+
setLoading(false);
42+
}
43+
});
44+
45+
return (
46+
<button
47+
disabled={isLoading}
48+
onClick={onClick}
49+
{...props}
50+
className={cn(
51+
buttonVariants({
52+
color: 'secondary',
53+
size: 'sm',
54+
className: 'gap-2 [&_svg]:size-3.5 [&_svg]:text-fd-muted-foreground',
55+
}),
56+
props.className,
57+
)}
58+
>
59+
{checked ? <Check /> : <Copy />}
60+
{props.children ?? 'Copy Markdown'}
61+
</button>
62+
);
63+
}
64+
65+
/**
66+
* see https://fumadocs.dev/docs/integrations/llms#page-actions to customise.
67+
*/
68+
export function ViewOptionsPopover({
69+
markdownUrl,
70+
githubUrl,
71+
...props
72+
}: ComponentProps<typeof PopoverTrigger> & {
73+
/**
74+
* A URL to the raw Markdown/MDX content of page
75+
*/
76+
markdownUrl?: string;
77+
78+
/**
79+
* Source file URL on GitHub
80+
*/
81+
githubUrl?: string;
82+
}) {
83+
const pathname = usePathname();
84+
const items = useMemo(() => {
85+
const pageUrl =
86+
typeof window === 'undefined' ? pathname : new URL(pathname, window.location.origin);
87+
const q = `Read ${pageUrl}, I want to ask questions about it.`;
88+
89+
return [
90+
githubUrl && {
91+
title: 'Open in GitHub',
92+
href: githubUrl,
93+
icon: (
94+
<svg fill="currentColor" role="img" viewBox="0 0 24 24">
95+
<title>GitHub</title>
96+
<path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12" />
97+
</svg>
98+
),
99+
},
100+
markdownUrl && {
101+
title: 'View as Markdown',
102+
href: markdownUrl,
103+
icon: <TextIcon />,
104+
},
105+
{
106+
title: 'Open in Scira AI',
107+
href: `https://scira.ai/?${new URLSearchParams({
108+
q,
109+
})}`,
110+
icon: (
111+
<svg
112+
width="910"
113+
height="934"
114+
viewBox="0 0 910 934"
115+
fill="none"
116+
xmlns="http://www.w3.org/2000/svg"
117+
>
118+
<title>Scira AI</title>
119+
<path
120+
d="M647.664 197.775C569.13 189.049 525.5 145.419 516.774 66.8849C508.048 145.419 464.418 189.049 385.884 197.775C464.418 206.501 508.048 250.131 516.774 328.665C525.5 250.131 569.13 206.501 647.664 197.775Z"
121+
fill="currentColor"
122+
stroke="currentColor"
123+
strokeWidth="8"
124+
strokeLinejoin="round"
125+
/>
126+
<path
127+
d="M516.774 304.217C510.299 275.491 498.208 252.087 480.335 234.214C462.462 216.341 439.058 204.251 410.333 197.775C439.059 191.3 462.462 179.209 480.335 161.336C498.208 143.463 510.299 120.06 516.774 91.334C523.25 120.059 535.34 143.463 553.213 161.336C571.086 179.209 594.49 191.3 623.216 197.775C594.49 204.251 571.086 216.341 553.213 234.214C535.34 252.087 523.25 275.491 516.774 304.217Z"
128+
fill="currentColor"
129+
stroke="currentColor"
130+
strokeWidth="8"
131+
strokeLinejoin="round"
132+
/>
133+
<path
134+
d="M857.5 508.116C763.259 497.644 710.903 445.288 700.432 351.047C689.961 445.288 637.605 497.644 543.364 508.116C637.605 518.587 689.961 570.943 700.432 665.184C710.903 570.943 763.259 518.587 857.5 508.116Z"
135+
stroke="currentColor"
136+
strokeWidth="20"
137+
strokeLinejoin="round"
138+
/>
139+
<path
140+
d="M700.432 615.957C691.848 589.05 678.575 566.357 660.383 548.165C642.191 529.973 619.499 516.7 592.593 508.116C619.499 499.533 642.191 486.258 660.383 468.066C678.575 449.874 691.848 427.181 700.432 400.274C709.015 427.181 722.289 449.874 740.481 468.066C758.673 486.258 781.365 499.533 808.271 508.116C781.365 516.7 758.673 529.973 740.481 548.165C722.289 566.357 709.015 589.05 700.432 615.957Z"
141+
stroke="currentColor"
142+
strokeWidth="20"
143+
strokeLinejoin="round"
144+
/>
145+
<path
146+
d="M889.949 121.237C831.049 114.692 798.326 81.9698 791.782 23.0692C785.237 81.9698 752.515 114.692 693.614 121.237C752.515 127.781 785.237 160.504 791.782 219.404C798.326 160.504 831.049 127.781 889.949 121.237Z"
147+
fill="currentColor"
148+
stroke="currentColor"
149+
strokeWidth="8"
150+
strokeLinejoin="round"
151+
/>
152+
<path
153+
d="M791.782 196.795C786.697 176.937 777.869 160.567 765.16 147.858C752.452 135.15 736.082 126.322 716.226 121.237C736.082 116.152 752.452 107.324 765.16 94.6152C777.869 81.9065 786.697 65.5368 791.782 45.6797C796.867 65.5367 805.695 81.9066 818.403 94.6152C831.112 107.324 847.481 116.152 867.338 121.237C847.481 126.322 831.112 135.15 818.403 147.858C805.694 160.567 796.867 176.937 791.782 196.795Z"
154+
fill="currentColor"
155+
stroke="currentColor"
156+
strokeWidth="8"
157+
strokeLinejoin="round"
158+
/>
159+
<path
160+
d="M760.632 764.337C720.719 814.616 669.835 855.1 611.872 882.692C553.91 910.285 490.404 924.255 426.213 923.533C362.022 922.812 298.846 907.419 241.518 878.531C184.19 849.643 134.228 808.026 95.4548 756.863C56.6815 705.7 30.1238 646.346 17.8129 583.343C5.50207 520.339 7.76433 455.354 24.4266 393.359C41.089 331.364 71.7099 274.001 113.947 225.658C156.184 177.315 208.919 139.273 268.117 114.442"
161+
stroke="currentColor"
162+
strokeWidth="30"
163+
strokeLinecap="round"
164+
strokeLinejoin="round"
165+
/>
166+
</svg>
167+
),
168+
},
169+
{
170+
title: 'Open in ChatGPT',
171+
href: `https://chatgpt.com/?${new URLSearchParams({
172+
hints: 'search',
173+
q,
174+
})}`,
175+
icon: (
176+
<svg
177+
role="img"
178+
viewBox="0 0 24 24"
179+
fill="currentColor"
180+
xmlns="http://www.w3.org/2000/svg"
181+
>
182+
<title>OpenAI</title>
183+
<path d="M22.2819 9.8211a5.9847 5.9847 0 0 0-.5157-4.9108 6.0462 6.0462 0 0 0-6.5098-2.9A6.0651 6.0651 0 0 0 4.9807 4.1818a5.9847 5.9847 0 0 0-3.9977 2.9 6.0462 6.0462 0 0 0 .7427 7.0966 5.98 5.98 0 0 0 .511 4.9107 6.051 6.051 0 0 0 6.5146 2.9001A5.9847 5.9847 0 0 0 13.2599 24a6.0557 6.0557 0 0 0 5.7718-4.2058 5.9894 5.9894 0 0 0 3.9977-2.9001 6.0557 6.0557 0 0 0-.7475-7.0729zm-9.022 12.6081a4.4755 4.4755 0 0 1-2.8764-1.0408l.1419-.0804 4.7783-2.7582a.7948.7948 0 0 0 .3927-.6813v-6.7369l2.02 1.1686a.071.071 0 0 1 .038.052v5.5826a4.504 4.504 0 0 1-4.4945 4.4944zm-9.6607-4.1254a4.4708 4.4708 0 0 1-.5346-3.0137l.142.0852 4.783 2.7582a.7712.7712 0 0 0 .7806 0l5.8428-3.3685v2.3324a.0804.0804 0 0 1-.0332.0615L9.74 19.9502a4.4992 4.4992 0 0 1-6.1408-1.6464zM2.3408 7.8956a4.485 4.485 0 0 1 2.3655-1.9728V11.6a.7664.7664 0 0 0 .3879.6765l5.8144 3.3543-2.0201 1.1685a.0757.0757 0 0 1-.071 0l-4.8303-2.7865A4.504 4.504 0 0 1 2.3408 7.872zm16.5963 3.8558L13.1038 8.364 15.1192 7.2a.0757.0757 0 0 1 .071 0l4.8303 2.7913a4.4944 4.4944 0 0 1-.6765 8.1042v-5.6772a.79.79 0 0 0-.407-.667zm2.0107-3.0231l-.142-.0852-4.7735-2.7818a.7759.7759 0 0 0-.7854 0L9.409 9.2297V6.8974a.0662.0662 0 0 1 .0284-.0615l4.8303-2.7866a4.4992 4.4992 0 0 1 6.6802 4.66zM8.3065 12.863l-2.02-1.1638a.0804.0804 0 0 1-.038-.0567V6.0742a4.4992 4.4992 0 0 1 7.3757-3.4537l-.142.0805L8.704 5.459a.7948.7948 0 0 0-.3927.6813zm1.0976-2.3654l2.602-1.4998 2.6069 1.4998v2.9994l-2.5974 1.4997-2.6067-1.4997Z" />
184+
</svg>
185+
),
186+
},
187+
{
188+
title: 'Open in Claude',
189+
href: `https://claude.ai/new?${new URLSearchParams({
190+
q,
191+
})}`,
192+
icon: (
193+
<svg
194+
fill="currentColor"
195+
role="img"
196+
viewBox="0 0 24 24"
197+
xmlns="http://www.w3.org/2000/svg"
198+
>
199+
<title>Anthropic</title>
200+
<path d="M17.3041 3.541h-3.6718l6.696 16.918H24Zm-10.6082 0L0 20.459h3.7442l1.3693-3.5527h7.0052l1.3693 3.5528h3.7442L10.5363 3.5409Zm-.3712 10.2232 2.2914-5.9456 2.2914 5.9456Z" />
201+
</svg>
202+
),
203+
},
204+
{
205+
title: 'Open in Cursor',
206+
icon: (
207+
<svg
208+
fill="currentColor"
209+
role="img"
210+
viewBox="0 0 24 24"
211+
xmlns="http://www.w3.org/2000/svg"
212+
>
213+
<title>Cursor</title>
214+
<path d="M11.503.131 1.891 5.678a.84.84 0 0 0-.42.726v11.188c0 .3.162.575.42.724l9.609 5.55a1 1 0 0 0 .998 0l9.61-5.55a.84.84 0 0 0 .42-.724V6.404a.84.84 0 0 0-.42-.726L12.497.131a1.01 1.01 0 0 0-.996 0M2.657 6.338h18.55c.263 0 .43.287.297.515L12.23 22.918c-.062.107-.229.064-.229-.06V12.335a.59.59 0 0 0-.295-.51l-9.11-5.257c-.109-.063-.064-.23.061-.23" />
215+
</svg>
216+
),
217+
href: `https://cursor.com/link/prompt?${new URLSearchParams({
218+
text: q,
219+
})}`,
220+
},
221+
].filter((v) => !!v);
222+
}, [githubUrl, markdownUrl, pathname]);
223+
224+
return (
225+
<Popover>
226+
<PopoverTrigger
227+
{...props}
228+
className={cn(
229+
buttonVariants({
230+
color: 'secondary',
231+
size: 'sm',
232+
}),
233+
'gap-2 data-[state=open]:bg-fd-accent data-[state=open]:text-fd-accent-foreground',
234+
props.className,
235+
)}
236+
>
237+
{props.children ?? 'Open'}
238+
<ChevronDown className="size-3.5 text-fd-muted-foreground" />
239+
</PopoverTrigger>
240+
<PopoverContent className="flex flex-col">
241+
{items.map((item) => (
242+
<a
243+
key={item.href}
244+
href={item.href}
245+
rel="noreferrer noopener"
246+
target="_blank"
247+
className="text-sm p-2 rounded-lg inline-flex items-center gap-2 hover:text-fd-accent-foreground hover:bg-fd-accent [&_svg]:size-4"
248+
>
249+
{item.icon}
250+
{item.title}
251+
<ExternalLinkIcon className="text-fd-muted-foreground size-3.5 ms-auto" />
252+
</a>
253+
))}
254+
</PopoverContent>
255+
</Popover>
256+
);
257+
}

0 commit comments

Comments
 (0)