@stainless-api/docs 0.1.0-beta.7 → 0.1.0-beta.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/README.md +1 -1
- package/package.json +2 -2
- package/plugin/globalJs/ai-dropdown.ts +57 -0
- package/plugin/globalJs/navigation.ts +22 -0
- package/plugin/loadPluginConfig.ts +7 -0
- package/plugin/react/Routing.tsx +22 -13
- package/plugin/replaceSidebarPlaceholderMiddleware.ts +4 -0
- package/plugin/routes/Docs.astro +5 -3
- package/stl-docs/components/APIReferenceAIDropdown.tsx +58 -0
- package/stl-docs/components/content-panel/ContentBreadcrumbs.tsx +8 -16
- package/stl-docs/components/content-panel/ContentPanel.astro +32 -10
- package/stl-docs/components/content-panel/ProseAIDropdown.tsx +55 -0
- package/stl-docs/components/icons/chat-gpt.tsx +17 -0
- package/stl-docs/components/icons/claude.tsx +10 -0
- package/stl-docs/components/icons/markdown.tsx +10 -0
- package/stl-docs/components/nav-tabs/buildNavLinks.ts +2 -2
- package/stl-docs/index.ts +1 -0
- package/stl-docs/loadStlDocsConfig.ts +2 -0
- package/stl-docs/tabsMiddleware.ts +1 -1
- package/styles/overrides.css +0 -4
- package/styles/page.css +9 -0
- package/virtual-module.d.ts +1 -0
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
package/package.json
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stainless-api/docs",
|
|
3
|
-
"version": "0.1.0-beta.
|
|
3
|
+
"version": "0.1.0-beta.8",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
7
7
|
"description": "",
|
|
8
8
|
"type": "module",
|
|
9
9
|
"exports": {
|
|
10
|
+
".": "./stl-docs/index.ts",
|
|
10
11
|
"./plugin": "./plugin/index.ts",
|
|
11
12
|
"./OverviewRoute": "./plugin/routes/Overview.astro",
|
|
12
13
|
"./DocsRoute": "./plugin/routes/Docs.astro",
|
|
@@ -16,7 +17,6 @@
|
|
|
16
17
|
"./replaceSidebarPlaceholderMiddleware": "./plugin/replaceSidebarPlaceholderMiddleware.ts",
|
|
17
18
|
"./plugin/middleware": "./plugin/middlewareBuilder/stlStarlightMiddleware.ts",
|
|
18
19
|
"./plugin/MiddlewareTypes": "./plugin/middlewareBuilder/stainlessMiddleware.d.ts",
|
|
19
|
-
"./stainless-docs": "./stl-docs/index.ts",
|
|
20
20
|
"./Header": "./stl-docs/components/Header.astro",
|
|
21
21
|
"./ThemeSelect": "./stl-docs/components/ThemeSelect.astro",
|
|
22
22
|
"./BaseSidebar": "./stl-docs/components/sidebars/BaseSidebar.astro",
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
export const copyCurrentPageAsMarkdown = async () => {
|
|
2
|
+
const currentUrl = new URL(window.location.href);
|
|
3
|
+
const markdownUrl = `${currentUrl.origin}${currentUrl.pathname}.md`;
|
|
4
|
+
|
|
5
|
+
try {
|
|
6
|
+
const response = await fetch(markdownUrl);
|
|
7
|
+
if (!response.ok) {
|
|
8
|
+
throw new Error('Network response was not ok');
|
|
9
|
+
}
|
|
10
|
+
const markdown = await response.text();
|
|
11
|
+
await navigator.clipboard.writeText(markdown);
|
|
12
|
+
console.log('Markdown copied to clipboard');
|
|
13
|
+
} catch (error) {
|
|
14
|
+
console.error('There has been a problem with your fetch operation:', error);
|
|
15
|
+
}
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
export function onSelectAIOption(value: string, makeMarkdownLink: boolean = true) {
|
|
19
|
+
if (value === 'copy-markdown') {
|
|
20
|
+
copyCurrentPageAsMarkdown();
|
|
21
|
+
}
|
|
22
|
+
if (value === 'view-as-markdown') {
|
|
23
|
+
const currentUrl = new URL(window.location.href);
|
|
24
|
+
const markdownUrl = `${currentUrl.origin}${currentUrl.pathname}.md`;
|
|
25
|
+
window.open(markdownUrl, '_blank');
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
if (value === 'chat-gpt') {
|
|
29
|
+
const currentUrl = new URL(window.location.href);
|
|
30
|
+
const llmUrl = makeMarkdownLink ? `${currentUrl.origin}${currentUrl.pathname}.md` : currentUrl.href;
|
|
31
|
+
|
|
32
|
+
const prompt = `Read from ${llmUrl} so I can ask questions about it.`;
|
|
33
|
+
|
|
34
|
+
const chatGptUrl = `https://chatgpt.com/?hints=search&prompt=${encodeURIComponent(prompt)}`;
|
|
35
|
+
window.open(chatGptUrl, '_blank');
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
if (value === 'claude') {
|
|
39
|
+
const currentUrl = new URL(window.location.href);
|
|
40
|
+
const llmUrl = makeMarkdownLink ? `${currentUrl.origin}${currentUrl.pathname}.md` : currentUrl.href;
|
|
41
|
+
|
|
42
|
+
const prompt = `Read from ${llmUrl} so I can ask questions about it.`;
|
|
43
|
+
|
|
44
|
+
const claudeUrl = `https://claude.ai/new?q=${encodeURIComponent(prompt)}`;
|
|
45
|
+
window.open(claudeUrl, '_blank');
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
if (value === 'cursor') {
|
|
49
|
+
const currentUrl = new URL(window.location.href);
|
|
50
|
+
const llmUrl = makeMarkdownLink ? `${currentUrl.origin}${currentUrl.pathname}.md` : currentUrl.href;
|
|
51
|
+
|
|
52
|
+
const prompt = `Read from ${llmUrl} so I can ask questions about it.`;
|
|
53
|
+
|
|
54
|
+
const cursorUrl = `https://www.cursor.so/?prompt=${encodeURIComponent(prompt)}`;
|
|
55
|
+
window.open(cursorUrl, '_blank');
|
|
56
|
+
}
|
|
57
|
+
}
|
|
@@ -5,6 +5,8 @@ import { navigate } from 'astro:transitions/client';
|
|
|
5
5
|
import { getPageLoadEvent } from '../helpers/getPageLoadEvent.ts';
|
|
6
6
|
|
|
7
7
|
import { initDropdown } from '@stainless-api/docs-ui/src/components/scripts/dropdown';
|
|
8
|
+
import { initDropdownButton } from '@stainless-api/ui-primitives/scripts';
|
|
9
|
+
import { copyCurrentPageAsMarkdown, onSelectAIOption } from './ai-dropdown.ts';
|
|
8
10
|
|
|
9
11
|
history.scrollRestoration = 'auto';
|
|
10
12
|
|
|
@@ -34,6 +36,26 @@ document.addEventListener(getPageLoadEvent(), () => {
|
|
|
34
36
|
if (path) setTimeout(() => scrollToPath(path.slice(1)), 10);
|
|
35
37
|
});
|
|
36
38
|
|
|
39
|
+
document.addEventListener(getPageLoadEvent(), () => {
|
|
40
|
+
initDropdownButton({
|
|
41
|
+
dropdownId: 'ai-dropdown-button',
|
|
42
|
+
onSelect: onSelectAIOption,
|
|
43
|
+
onPrimaryAction: (el) => {
|
|
44
|
+
copyCurrentPageAsMarkdown();
|
|
45
|
+
const innerText = el.querySelector('[data-part="primary-action-text"]');
|
|
46
|
+
if (!innerText) return;
|
|
47
|
+
|
|
48
|
+
const originalInnerHtml = innerText.innerHTML;
|
|
49
|
+
innerText.innerHTML = 'Copied!';
|
|
50
|
+
el.classList.add('disabled');
|
|
51
|
+
setTimeout(() => {
|
|
52
|
+
innerText.innerHTML = originalInnerHtml;
|
|
53
|
+
el.classList.remove('disabled');
|
|
54
|
+
}, 1000);
|
|
55
|
+
},
|
|
56
|
+
});
|
|
57
|
+
});
|
|
58
|
+
|
|
37
59
|
document.addEventListener('click', (event) => {
|
|
38
60
|
const toggle = (event.target as HTMLElement).closest(
|
|
39
61
|
'[data-stldocs-property-toggle-expanded] > .stldocs-expand-toggle-content',
|
|
@@ -117,6 +117,13 @@ export type StainlessStarlightUserConfig = {
|
|
|
117
117
|
* Defaults to `false`.
|
|
118
118
|
*/
|
|
119
119
|
experimentalCollapsibleSnippets?: boolean;
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* When set to `true`, a dropdown button will be included on all pages to allow users to
|
|
123
|
+
* view or send markdown to an LLM.
|
|
124
|
+
* Defaults to `false`.
|
|
125
|
+
*/
|
|
126
|
+
includeAIDropdownOptions?: boolean;
|
|
120
127
|
};
|
|
121
128
|
|
|
122
129
|
export type ExternalSpecServerUserConfig = Omit<StainlessStarlightUserConfig, 'stainlessProject'> & {
|
package/plugin/react/Routing.tsx
CHANGED
|
@@ -55,6 +55,7 @@ import { SnippetCode, SnippetContainer, SnippetRequestContainer } from '../compo
|
|
|
55
55
|
import clsx from 'clsx';
|
|
56
56
|
import type { StlStarlightMiddleware } from '../middlewareBuilder/stainlessMiddleware';
|
|
57
57
|
import { ComponentProvider } from '@stainless-api/docs-ui/src/contexts/component';
|
|
58
|
+
import { APIReferenceAIDropdown } from '../../stl-docs/components/APIReferenceAIDropdown';
|
|
58
59
|
|
|
59
60
|
export function generateDocsRoutes(spec: SDKJSON.Spec) {
|
|
60
61
|
const paths = generateRouteList({
|
|
@@ -324,12 +325,15 @@ export function RenderSpec({
|
|
|
324
325
|
<MarkdownProvider render={renderMarkdown} highlight={highlight}>
|
|
325
326
|
{kind === 'http_method' ? (
|
|
326
327
|
<div className="stldocs-root stl-ui-not-prose">
|
|
327
|
-
<
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
328
|
+
<div className="stl-page-nav-container">
|
|
329
|
+
<SDKBreadcrumbs
|
|
330
|
+
spec={spec as SDKJSON.Spec}
|
|
331
|
+
currentPath={currentPath}
|
|
332
|
+
basePath={BASE_PATH}
|
|
333
|
+
config={BREADCRUMB_CONFIG}
|
|
334
|
+
/>
|
|
335
|
+
<APIReferenceAIDropdown />
|
|
336
|
+
</div>
|
|
333
337
|
<SDKMethod
|
|
334
338
|
method={resource.methods[parsed.method]}
|
|
335
339
|
transformRequestSnippet={transformRequestSnippet}
|
|
@@ -337,12 +341,15 @@ export function RenderSpec({
|
|
|
337
341
|
</div>
|
|
338
342
|
) : (
|
|
339
343
|
<div className="stldocs-root stl-ui-not-prose">
|
|
340
|
-
<
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
344
|
+
<div className="stl-page-nav-container">
|
|
345
|
+
<SDKBreadcrumbs
|
|
346
|
+
spec={spec as SDKJSON.Spec}
|
|
347
|
+
currentPath={currentPath}
|
|
348
|
+
basePath={BASE_PATH}
|
|
349
|
+
config={BREADCRUMB_CONFIG}
|
|
350
|
+
/>
|
|
351
|
+
<APIReferenceAIDropdown />
|
|
352
|
+
</div>
|
|
346
353
|
<SDKOverview resource={resource} />
|
|
347
354
|
</div>
|
|
348
355
|
)}
|
|
@@ -375,7 +382,9 @@ export async function getReadmeContent(spec: SDKJSON.Spec, language: DocsLanguag
|
|
|
375
382
|
const response = await fetch(`${rawUrl}/refs/heads/main/README.md`);
|
|
376
383
|
if (response && response.ok) return response.text();
|
|
377
384
|
}
|
|
378
|
-
} catch
|
|
385
|
+
} catch {
|
|
386
|
+
// ignore
|
|
387
|
+
}
|
|
379
388
|
|
|
380
389
|
return spec.readme[language];
|
|
381
390
|
}
|
|
@@ -15,6 +15,10 @@ export const onRequest = defineRouteMiddleware(async (context) => {
|
|
|
15
15
|
|
|
16
16
|
const slug = `/${context.locals.starlightRoute.id}`; // same as .slug but not deprecated
|
|
17
17
|
|
|
18
|
+
context.locals.starlightRoute._stlStarlight = {
|
|
19
|
+
basePath: BASE_PATH,
|
|
20
|
+
};
|
|
21
|
+
|
|
18
22
|
const apiReferencePlaceholderItems = getAPIReferencePlaceholderItems(context.locals.starlightRoute.sidebar);
|
|
19
23
|
|
|
20
24
|
const spec = await cmsClient.getSpec();
|
package/plugin/routes/Docs.astro
CHANGED
|
@@ -119,10 +119,12 @@ if (readme) {
|
|
|
119
119
|
.content-panel:nth-of-type(1) {
|
|
120
120
|
display: none;
|
|
121
121
|
}
|
|
122
|
+
.content-panel:nth-of-type(2) .stl-page-nav-container {
|
|
123
|
+
display: none;
|
|
124
|
+
}
|
|
122
125
|
|
|
123
|
-
.content-panel:nth-of-type(2) {
|
|
124
|
-
|
|
125
|
-
padding: 0;
|
|
126
|
+
.content-panel:nth-of-type(2) .stldocs-root .stl-page-nav-container {
|
|
127
|
+
display: flex;
|
|
126
128
|
}
|
|
127
129
|
</style>
|
|
128
130
|
</div>
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { DropdownButton } from '@stainless-api/ui-primitives';
|
|
2
|
+
import { CopyIcon } from 'lucide-react';
|
|
3
|
+
import { ChatGPTIcon } from './icons/chat-gpt';
|
|
4
|
+
import { ClaudeIcon } from './icons/claude';
|
|
5
|
+
import { MarkdownIcon } from './icons/markdown';
|
|
6
|
+
|
|
7
|
+
export function AIDropdownOptions() {
|
|
8
|
+
return (
|
|
9
|
+
<>
|
|
10
|
+
<DropdownButton.MenuItem value="claude" isExternalLink>
|
|
11
|
+
<DropdownButton.MenuItemIcon>
|
|
12
|
+
<ClaudeIcon />
|
|
13
|
+
</DropdownButton.MenuItemIcon>
|
|
14
|
+
<DropdownButton.MenuItemText subtle>
|
|
15
|
+
Open in
|
|
16
|
+
<strong> Claude</strong>
|
|
17
|
+
</DropdownButton.MenuItemText>
|
|
18
|
+
</DropdownButton.MenuItem>
|
|
19
|
+
<DropdownButton.MenuItem value="chat-gpt" isExternalLink>
|
|
20
|
+
<DropdownButton.MenuItemIcon>
|
|
21
|
+
<ChatGPTIcon />
|
|
22
|
+
</DropdownButton.MenuItemIcon>
|
|
23
|
+
<DropdownButton.MenuItemText subtle>
|
|
24
|
+
Open in
|
|
25
|
+
<strong> ChatGPT</strong>
|
|
26
|
+
</DropdownButton.MenuItemText>
|
|
27
|
+
</DropdownButton.MenuItem>
|
|
28
|
+
</>
|
|
29
|
+
);
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
export function APIReferenceAIDropdown() {
|
|
33
|
+
return (
|
|
34
|
+
<DropdownButton id="ai-dropdown-button">
|
|
35
|
+
<DropdownButton.PrimaryAction>
|
|
36
|
+
<CopyIcon size={16} />
|
|
37
|
+
<DropdownButton.PrimaryActionText>Copy Markdown</DropdownButton.PrimaryActionText>
|
|
38
|
+
</DropdownButton.PrimaryAction>
|
|
39
|
+
<DropdownButton.Trigger />
|
|
40
|
+
<DropdownButton.Menu>
|
|
41
|
+
<AIDropdownOptions />
|
|
42
|
+
<hr />
|
|
43
|
+
<DropdownButton.MenuItem value="copy-as-markdown" isExternalLink>
|
|
44
|
+
<DropdownButton.MenuItemIcon>
|
|
45
|
+
<CopyIcon size={16} />
|
|
46
|
+
</DropdownButton.MenuItemIcon>
|
|
47
|
+
<DropdownButton.MenuItemText>Copy Markdown</DropdownButton.MenuItemText>
|
|
48
|
+
</DropdownButton.MenuItem>
|
|
49
|
+
<DropdownButton.MenuItem value="view-as-markdown" isExternalLink>
|
|
50
|
+
<DropdownButton.MenuItemIcon>
|
|
51
|
+
<MarkdownIcon />
|
|
52
|
+
</DropdownButton.MenuItemIcon>
|
|
53
|
+
<DropdownButton.MenuItemText>View as Markdown</DropdownButton.MenuItemText>
|
|
54
|
+
</DropdownButton.MenuItem>
|
|
55
|
+
</DropdownButton.Menu>
|
|
56
|
+
</DropdownButton>
|
|
57
|
+
);
|
|
58
|
+
}
|
|
@@ -5,25 +5,22 @@ import type { StarlightRouteData } from '@astrojs/starlight/route-data';
|
|
|
5
5
|
|
|
6
6
|
type Breadcrumb = { title: string; href: string };
|
|
7
7
|
|
|
8
|
-
// because this component is used in Stainless Docs and stl-starlight, we need to conditionally import the BASE_PATH from the virtual module
|
|
9
|
-
let basePath: string | null = null;
|
|
10
|
-
try {
|
|
11
|
-
const mod = await import('virtual:stl-starlight-virtual-module');
|
|
12
|
-
basePath = mod.BASE_PATH;
|
|
13
|
-
// eslint-disable-next-line no-empty, @typescript-eslint/no-unused-vars
|
|
14
|
-
} catch (_e) {}
|
|
15
|
-
|
|
16
8
|
// Normalize paths to avoid mismatches due to trailing slashes
|
|
17
9
|
function normalizePath(path: string) {
|
|
18
10
|
return path.endsWith('/') ? path : path + '/';
|
|
19
11
|
}
|
|
20
12
|
|
|
21
|
-
function findBreadcrumbTrail(
|
|
22
|
-
|
|
13
|
+
export function findBreadcrumbTrail(
|
|
14
|
+
sidebarEntry: StarlightRouteData['sidebar'],
|
|
23
15
|
targetPath: string,
|
|
24
16
|
includeCurrentPage: boolean,
|
|
25
17
|
trail: Breadcrumb[] = [],
|
|
26
18
|
): Breadcrumb[] | null {
|
|
19
|
+
const entries = sidebarEntry.filter((entry) => {
|
|
20
|
+
return !(
|
|
21
|
+
entry as StarlightRouteData['sidebar'][number] & { attrs?: { class?: string } }
|
|
22
|
+
).attrs?.class?.includes('stl-mobile-only-sidebar-item');
|
|
23
|
+
});
|
|
27
24
|
const normalizedTarget = normalizePath(targetPath);
|
|
28
25
|
|
|
29
26
|
for (const entry of entries) {
|
|
@@ -57,12 +54,7 @@ export function ContentBreadcrumbs({
|
|
|
57
54
|
currentPath: string;
|
|
58
55
|
sidebarEntry: StarlightRouteData['sidebar'];
|
|
59
56
|
}) {
|
|
60
|
-
|
|
61
|
-
return null;
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
const entryWithoutTopLevelLinks = sidebarEntry.filter((entry) => entry.type !== 'link');
|
|
65
|
-
const breadcrumbs = findBreadcrumbTrail(entryWithoutTopLevelLinks, currentPath, true);
|
|
57
|
+
const breadcrumbs = findBreadcrumbTrail(sidebarEntry, currentPath, true);
|
|
66
58
|
|
|
67
59
|
if (!breadcrumbs) {
|
|
68
60
|
return null;
|
|
@@ -1,12 +1,20 @@
|
|
|
1
1
|
---
|
|
2
2
|
import { ContentBreadcrumbs } from './ContentBreadcrumbs';
|
|
3
|
+
import { ProseAIDropdown } from './ProseAIDropdown';
|
|
4
|
+
import { INCLUDE_AI_DROPDOWN_OPTIONS } from 'virtual:stl-docs-virtual-module';
|
|
5
|
+
|
|
3
6
|
const currentPath = Astro.url.pathname;
|
|
4
7
|
---
|
|
5
8
|
|
|
6
9
|
<div class="content-panel">
|
|
7
10
|
<div class="sl-container stl-ui-prose">
|
|
8
|
-
<div class="stl-ui-not-prose">
|
|
11
|
+
<div class="stl-ui-not-prose stl-page-nav-container stl-prose-page-nav-container">
|
|
9
12
|
<ContentBreadcrumbs currentPath={currentPath} sidebarEntry={Astro.locals.starlightRoute.sidebar} />
|
|
13
|
+
{
|
|
14
|
+
INCLUDE_AI_DROPDOWN_OPTIONS && (
|
|
15
|
+
<ProseAIDropdown currentPath={currentPath} sidebarEntry={Astro.locals.starlightRoute.sidebar} />
|
|
16
|
+
)
|
|
17
|
+
}
|
|
10
18
|
</div>
|
|
11
19
|
<slot />
|
|
12
20
|
</div>
|
|
@@ -24,10 +32,6 @@ const currentPath = Astro.url.pathname;
|
|
|
24
32
|
max-width: var(--sl-content-width);
|
|
25
33
|
}
|
|
26
34
|
|
|
27
|
-
.sl-container > :global(* + *) {
|
|
28
|
-
margin-top: 1.5rem;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
35
|
@media (min-width: 72rem) {
|
|
32
36
|
.sl-container {
|
|
33
37
|
margin-inline: var(--sl-content-margin-inline, auto);
|
|
@@ -37,15 +41,33 @@ const currentPath = Astro.url.pathname;
|
|
|
37
41
|
/* Overrides */
|
|
38
42
|
@layer stainless {
|
|
39
43
|
.content-panel {
|
|
40
|
-
padding: 0 var(--sl-content-pad-x);
|
|
44
|
+
padding: 0 0.5rem 0 var(--sl-content-pad-x);
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
.stl-prose-page-nav-container {
|
|
48
|
+
padding: 1rem 0 0;
|
|
41
49
|
}
|
|
42
50
|
}
|
|
43
51
|
</style>
|
|
44
52
|
|
|
45
53
|
<style is:global>
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
display: none;
|
|
49
|
-
}
|
|
54
|
+
.content-panel:nth-of-type(2) .stl-page-nav-container {
|
|
55
|
+
display: none;
|
|
50
56
|
}
|
|
51
57
|
</style>
|
|
58
|
+
|
|
59
|
+
<script>
|
|
60
|
+
import { initDropdownButton } from '@stainless-api/ui-primitives/scripts';
|
|
61
|
+
import { getPageLoadEvent } from '../../../plugin/helpers/getPageLoadEvent';
|
|
62
|
+
import { onSelectAIOption } from '../../../plugin/globalJs/ai-dropdown.ts';
|
|
63
|
+
|
|
64
|
+
document.addEventListener(getPageLoadEvent(), () => {
|
|
65
|
+
initDropdownButton({
|
|
66
|
+
dropdownId: 'prose-ai-dropdown-button',
|
|
67
|
+
onSelect: (option: string) => onSelectAIOption(option, false),
|
|
68
|
+
onPrimaryAction: () => {
|
|
69
|
+
onSelectAIOption('claude', false);
|
|
70
|
+
},
|
|
71
|
+
});
|
|
72
|
+
});
|
|
73
|
+
</script>
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { DropdownButton } from '@stainless-api/ui-primitives';
|
|
2
|
+
import { AIDropdownOptions } from '../APIReferenceAIDropdown';
|
|
3
|
+
import type { StarlightRouteData } from '@astrojs/starlight/route-data';
|
|
4
|
+
import { ClaudeIcon } from '../icons/claude';
|
|
5
|
+
|
|
6
|
+
const sidebarHasEntry = (sidebarEntry: StarlightRouteData['sidebar'], currentPath?: string) => {
|
|
7
|
+
if (!currentPath) return false;
|
|
8
|
+
const normalizePath = (path: string) => {
|
|
9
|
+
return path.endsWith('/') ? path : path + '/';
|
|
10
|
+
};
|
|
11
|
+
|
|
12
|
+
const normalizedCurrent = normalizePath(currentPath);
|
|
13
|
+
|
|
14
|
+
for (const entry of sidebarEntry) {
|
|
15
|
+
if (entry.type === 'link') {
|
|
16
|
+
const normalizedHref = normalizePath(entry.href);
|
|
17
|
+
if (normalizedHref === normalizedCurrent) {
|
|
18
|
+
return true;
|
|
19
|
+
}
|
|
20
|
+
} else if (entry.type === 'group') {
|
|
21
|
+
const hasInGroup = sidebarHasEntry(entry.entries, currentPath);
|
|
22
|
+
if (hasInGroup) return true;
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
return false;
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
export function ProseAIDropdown({
|
|
30
|
+
currentPath,
|
|
31
|
+
sidebarEntry,
|
|
32
|
+
}: {
|
|
33
|
+
currentPath: string;
|
|
34
|
+
sidebarEntry: StarlightRouteData['sidebar'];
|
|
35
|
+
}) {
|
|
36
|
+
// Hide if there is no associated sidebar entry. This applies to pages like the 404 page.
|
|
37
|
+
const hasEntry = sidebarHasEntry(sidebarEntry, currentPath);
|
|
38
|
+
|
|
39
|
+
if (!hasEntry) {
|
|
40
|
+
return null;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
return (
|
|
44
|
+
<DropdownButton id="prose-ai-dropdown-button">
|
|
45
|
+
<DropdownButton.PrimaryAction>
|
|
46
|
+
<ClaudeIcon />
|
|
47
|
+
Open in Claude
|
|
48
|
+
</DropdownButton.PrimaryAction>
|
|
49
|
+
<DropdownButton.Trigger />
|
|
50
|
+
<DropdownButton.Menu>
|
|
51
|
+
<AIDropdownOptions />
|
|
52
|
+
</DropdownButton.Menu>
|
|
53
|
+
</DropdownButton>
|
|
54
|
+
);
|
|
55
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
export function ChatGPTIcon() {
|
|
2
|
+
return (
|
|
3
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" fill="none">
|
|
4
|
+
<g clip-path="url(#clip0_2771_126147)">
|
|
5
|
+
<path
|
|
6
|
+
d="M14.853 6.54857C15.216 5.45907 15.091 4.26557 14.5105 3.27457C13.6375 1.75457 11.8825 0.972574 10.1685 1.34057C9.40596 0.481574 8.31046 -0.00692579 7.16196 7.42116e-05C5.40996 -0.00392579 3.85546 1.12407 3.31646 2.79107C2.19096 3.02157 1.21946 3.72607 0.650955 4.72457C-0.228545 6.24057 -0.0280446 8.15157 1.14696 9.45157C0.783955 10.5411 0.908955 11.7346 1.48946 12.7256C2.36246 14.2456 4.11746 15.0276 5.83146 14.6596C6.59346 15.5186 7.68946 16.0071 8.83796 15.9996C10.591 16.0041 12.146 14.8751 12.685 13.2066C13.8105 12.9761 14.782 12.2716 15.3505 11.2731C16.229 9.75707 16.028 7.84757 14.8535 6.54757L14.853 6.54857ZM8.83896 14.9541C8.13746 14.9551 7.45796 14.7096 6.91946 14.2601C6.94396 14.2471 6.98646 14.2236 7.01396 14.2066L10.2 12.3666C10.363 12.2741 10.463 12.1006 10.462 11.9131V7.42157L11.8085 8.19907C11.823 8.20607 11.8325 8.22007 11.8345 8.23607V11.9556C11.8325 13.6096 10.493 14.9506 8.83896 14.9541ZM2.39696 12.2026C2.04546 11.5956 1.91896 10.8841 2.03946 10.1936C2.06296 10.2076 2.10446 10.2331 2.13396 10.2501L5.31996 12.0901C5.48146 12.1846 5.68146 12.1846 5.84346 12.0901L9.73296 9.84407V11.3991C9.73396 11.4151 9.72646 11.4306 9.71396 11.4406L6.49346 13.3001C5.05896 14.1261 3.22696 13.6351 2.39746 12.2026H2.39696ZM1.55846 5.24807C1.90846 4.64007 2.46096 4.17507 3.11896 3.93357C3.11896 3.96107 3.11746 4.00957 3.11746 4.04357V7.72407C3.11646 7.91107 3.21646 8.08457 3.37896 8.17707L7.26846 10.4226L5.92196 11.2001C5.90846 11.2091 5.89146 11.2106 5.87646 11.2041L2.65546 9.34307C1.22396 8.51407 0.732955 6.68257 1.55796 5.24857L1.55846 5.24807ZM12.6215 7.82257L8.73196 5.57657L10.0785 4.79957C10.092 4.79057 10.109 4.78907 10.124 4.79557L13.345 6.65507C14.779 7.48357 15.2705 9.31807 14.442 10.7521C14.0915 11.3591 13.5395 11.8241 12.882 12.0661V8.27557C12.8835 8.08857 12.784 7.91557 12.622 7.82257H12.6215ZM13.9615 5.80557C13.938 5.79107 13.8965 5.76607 13.867 5.74907L10.681 3.90907C10.5195 3.81457 10.3195 3.81457 10.1575 3.90907L6.26796 6.15507V4.60007C6.26696 4.58407 6.27446 4.56857 6.28696 4.55857L9.50746 2.70057C10.942 1.87307 12.776 2.36557 13.603 3.80057C13.9525 4.40657 14.079 5.11607 13.9605 5.80557H13.9615ZM5.53596 8.57707L4.18896 7.79957C4.17446 7.79257 4.16496 7.77857 4.16296 7.76257V4.04307C4.16396 2.38707 5.50746 1.04507 7.16346 1.04607C7.86396 1.04607 8.54196 1.29207 9.08046 1.74007C9.05596 1.75307 9.01396 1.77657 8.98596 1.79357L5.79996 3.63357C5.63696 3.72607 5.53696 3.89907 5.53796 4.08657L5.53596 8.57607V8.57707ZM6.26746 7.00007L7.99996 5.99957L9.73246 6.99957V9.00007L7.99996 10.0001L6.26746 9.00007V7.00007Z"
|
|
7
|
+
fill="var(--stl-ui-foreground)"
|
|
8
|
+
/>
|
|
9
|
+
</g>
|
|
10
|
+
<defs>
|
|
11
|
+
<clipPath id="clip0_2771_126147">
|
|
12
|
+
<rect width="16" height="16" fill="white" />
|
|
13
|
+
</clipPath>
|
|
14
|
+
</defs>
|
|
15
|
+
</svg>
|
|
16
|
+
);
|
|
17
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export function ClaudeIcon() {
|
|
2
|
+
return (
|
|
3
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" fill="none">
|
|
4
|
+
<path
|
|
5
|
+
d="M3.13924 10.6036L6.28658 8.84444L6.33924 8.69111L6.28658 8.60638H6.13266L5.60608 8.5741L3.8076 8.52568L2.2481 8.46113L0.737215 8.38043L0.356456 8.29973L0 7.83169L0.0364557 7.59766L0.356456 7.38382L0.814177 7.42416L1.82684 7.49276L3.34582 7.59766L4.4476 7.66222L6.08 7.83169H6.33924L6.3757 7.72678L6.28658 7.66222L6.21772 7.59766L4.64608 6.53649L2.94481 5.4148L2.05367 4.76922L1.57165 4.44239L1.32861 4.13574L1.22329 3.46595L1.66076 2.98581L2.2481 3.02615L2.39797 3.0665L2.99342 3.52244L4.26532 4.50292L5.92608 5.72145L6.16911 5.92319L6.26633 5.8546L6.27848 5.80618L6.16911 5.62461L5.26582 3.99856L4.30177 2.34426L3.87241 1.65833L3.75899 1.24678C3.71848 1.07731 3.69013 0.93609 3.69013 0.762591L4.18835 0.0887672L4.4638 0L5.1281 0.0887672L5.4076 0.330859L5.82076 1.27098L6.48911 2.75178L7.52608 4.76518L7.82987 5.36234L7.9919 5.91512L8.05266 6.08459H8.15797V5.98775L8.24304 4.85395L8.40101 3.46192L8.55494 1.67044L8.60759 1.16608L8.85873 0.560847L9.35696 0.234023L9.74582 0.419627L10.0658 0.875567L10.0213 1.17011L9.83089 2.40075L9.45823 4.32942L9.21519 5.62058H9.35696L9.51899 5.45918L10.1752 4.59168L11.277 3.21983L11.763 2.67512L12.3301 2.07392L12.6947 1.78745H13.3833L13.8896 2.53793L13.6628 3.31263L12.9539 4.20837L12.3666 4.96693L11.5241 6.09669L10.9975 7.0005L11.0461 7.07313L11.1716 7.06103L13.0754 6.65754L14.1043 6.47193L15.3316 6.26212L15.8866 6.52035L15.9473 6.78262L15.7286 7.31926L14.4162 7.64205L12.877 7.9487L10.5843 8.48937L10.5559 8.50954L10.5884 8.54989L11.6213 8.64673L12.0628 8.67094H13.1443L15.1575 8.82023L15.6841 9.16723L16 9.59089L15.9473 9.91368L15.1372 10.3252L14.0435 10.067L11.4916 9.46177L10.6167 9.24389H10.4952V9.31652L11.2243 10.0267L12.561 11.229L14.2339 12.7784L14.319 13.1618L14.1043 13.4644L13.8775 13.4321L12.4071 12.3306L11.84 11.8343L10.5559 10.757H10.4709V10.8699L10.7666 11.3017L12.3301 13.6419L12.4111 14.3601L12.2977 14.5941L11.8927 14.7354L11.4471 14.6547L10.5316 13.3756L9.58785 11.9352L8.82633 10.644L8.73316 10.6964L8.28354 15.5181L8.07291 15.7642L7.58684 15.9498L7.18177 15.6432L6.96709 15.1469L7.18177 14.1664L7.44101 12.8874L7.65165 11.8706L7.84203 10.6077L7.95544 10.1881L7.94734 10.1598L7.85418 10.1719L6.89823 11.4792L5.44405 13.4361L4.29367 14.6627L4.01823 14.7717L3.54025 14.5255L3.58481 14.0857L3.85215 13.6944L5.44405 11.6769L6.40405 10.4261L7.0238 9.70387L7.01975 9.59896H6.98329L2.75443 12.3346L2.00101 12.4314L1.67696 12.1288L1.71747 11.6325L1.87139 11.4711L3.14329 10.5996L3.13924 10.6036Z"
|
|
6
|
+
fill="#D97757"
|
|
7
|
+
/>
|
|
8
|
+
</svg>
|
|
9
|
+
);
|
|
10
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export function MarkdownIcon() {
|
|
2
|
+
return (
|
|
3
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" fill="none">
|
|
4
|
+
<path
|
|
5
|
+
d="M14.8447 3.33301C15.151 3.33301 15.4455 3.45527 15.6621 3.67188C15.8785 3.88844 16 4.18213 16 4.48828V12.0254C15.9997 12.3315 15.8777 12.6254 15.6611 12.8418C15.4446 13.0581 15.1508 13.1797 14.8447 13.1797H1.15527C0.848967 13.1797 0.55449 13.0584 0.337891 12.8418C0.121288 12.6252 0 12.3307 0 12.0244V4.48828C1.09706e-05 4.18213 0.121501 3.88844 0.337891 3.67188C0.554493 3.45527 0.848951 3.33301 1.15527 3.33301H14.8447ZM1.15527 4.10254C1.10457 4.10245 1.0537 4.11247 1.00684 4.13184C0.960202 4.15116 0.917554 4.17917 0.881836 4.21484C0.845984 4.2507 0.817213 4.29396 0.797852 4.34082C0.778601 4.38756 0.769447 4.43773 0.769531 4.48828V12.0254C0.76962 12.0759 0.779409 12.1262 0.798828 12.1729C0.81827 12.2196 0.846978 12.2621 0.882812 12.2979C0.918602 12.3335 0.961134 12.3616 1.00781 12.3809C1.05454 12.4001 1.10474 12.4102 1.15527 12.4102H14.8447C14.9467 12.4101 15.045 12.3699 15.1172 12.2979C15.1893 12.2258 15.2293 12.1274 15.2295 12.0254V4.48828C15.2296 4.43774 15.2204 4.38755 15.2012 4.34082C15.1819 4.29403 15.1529 4.25166 15.1172 4.21582C15.0814 4.17999 15.0389 4.15126 14.9922 4.13184C14.9455 4.11249 14.8952 4.10258 14.8447 4.10254H1.15527ZM5.38477 7.56348L6.92285 5.64062H8.46094V10.8721H6.92285V7.87109L5.38477 9.79492L3.8457 7.87109V10.8711H2.30762V5.63965H3.8457L5.38477 7.56348ZM12.6924 8.33301H14.2305L11.9229 10.8711L9.61523 8.33301H11.1533V5.64062H12.6924V8.33301Z"
|
|
6
|
+
fill="#262626"
|
|
7
|
+
/>
|
|
8
|
+
</svg>
|
|
9
|
+
);
|
|
10
|
+
}
|
|
@@ -2,8 +2,8 @@ import type { StarlightRouteData } from '@astrojs/starlight/route-data';
|
|
|
2
2
|
import { TABS } from 'virtual:stl-docs-virtual-module';
|
|
3
3
|
|
|
4
4
|
export function buildNavLinks(starlightRoute: StarlightRouteData) {
|
|
5
|
-
// TODO: specify the type of Astro.locals.starlightRoute.
|
|
6
|
-
const activeTabIndex = starlightRoute.
|
|
5
|
+
// TODO: specify the type of Astro.locals.starlightRoute._stlDocs
|
|
6
|
+
const activeTabIndex = starlightRoute._stlDocs?.activeTabIndex;
|
|
7
7
|
|
|
8
8
|
const navLinks = TABS.map((item, index) => ({
|
|
9
9
|
...item,
|
package/stl-docs/index.ts
CHANGED
|
@@ -143,6 +143,7 @@ function stainlessDocsIntegration(config: NormalizedStainlessDocsConfig): AstroI
|
|
|
143
143
|
HEADER_LINKS: config.header.links,
|
|
144
144
|
HEADER_LAYOUT: config.header.layout,
|
|
145
145
|
ENABLE_CLIENT_ROUTER: config.enableClientRouter,
|
|
146
|
+
INCLUDE_AI_DROPDOWN_OPTIONS: config.includeAIDropdownOptions,
|
|
146
147
|
});
|
|
147
148
|
}
|
|
148
149
|
},
|
|
@@ -68,6 +68,7 @@ export type StainlessDocsUserConfig = {
|
|
|
68
68
|
starlightCompat?: ExperimentalStarlightCompatibilityConfig;
|
|
69
69
|
enableClientRouter?: boolean;
|
|
70
70
|
};
|
|
71
|
+
includeAIDropdownOptions?: boolean;
|
|
71
72
|
} & PassThroughStarlightConfigOptions;
|
|
72
73
|
|
|
73
74
|
type HeaderLayout = 'default' | 'stacked';
|
|
@@ -128,6 +129,7 @@ function normalizeConfig(userConfig: StainlessDocsUserConfig) {
|
|
|
128
129
|
enableClientRouter: userConfig.experimental?.enableClientRouter ?? false,
|
|
129
130
|
apiReference: userConfig.apiReference ?? null,
|
|
130
131
|
sidebar: userConfig.sidebar,
|
|
132
|
+
includeAIDropdownOptions: userConfig.includeAIDropdownOptions ?? false,
|
|
131
133
|
};
|
|
132
134
|
|
|
133
135
|
return configWithDefaults;
|
|
@@ -143,7 +143,7 @@ export const onRequest = defineRouteMiddleware(async (context) => {
|
|
|
143
143
|
}
|
|
144
144
|
|
|
145
145
|
// We store the active tab index so we can use it in our nav tabs component
|
|
146
|
-
context.locals.starlightRoute.
|
|
146
|
+
context.locals.starlightRoute._stlDocs = {
|
|
147
147
|
activeTabIndex: activeTabIndex.index,
|
|
148
148
|
};
|
|
149
149
|
|
package/styles/overrides.css
CHANGED
package/styles/page.css
CHANGED
package/virtual-module.d.ts
CHANGED