@stainless-api/docs 0.1.0-beta.40 → 0.1.0-beta.41
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
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stainless-api/docs",
|
|
3
|
-
"version": "0.1.0-beta.
|
|
3
|
+
"version": "0.1.0-beta.41",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
"react-dom": ">=19.0.0"
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
|
-
"@astrojs/markdown-remark": "^6.3.
|
|
34
|
+
"@astrojs/markdown-remark": "^6.3.9",
|
|
35
35
|
"@astrojs/react": "^4.4.2",
|
|
36
36
|
"@stainless-api/sdk": "0.1.0-alpha.12",
|
|
37
37
|
"cheerio": "^1.1.2",
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
"unified": "^11.0.5",
|
|
52
52
|
"web-worker": "^1.5.0",
|
|
53
53
|
"yaml": "^2.8.0",
|
|
54
|
-
"@stainless-api/docs-ui": "0.1.0-beta.
|
|
54
|
+
"@stainless-api/docs-ui": "0.1.0-beta.34",
|
|
55
55
|
"@stainless-api/ui-primitives": "0.1.0-beta.25"
|
|
56
56
|
},
|
|
57
57
|
"devDependencies": {
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
import { Icon } from '@astrojs/starlight/components';
|
|
3
3
|
import { DocsSearch } from './SearchIsland';
|
|
4
|
-
import { SEARCH } from 'virtual:stl-starlight-virtual-module';
|
|
5
4
|
import { Button } from '@stainless-api/ui-primitives';
|
|
6
5
|
---
|
|
7
6
|
|
|
@@ -32,14 +31,6 @@ import { Button } from '@stainless-api/ui-primitives';
|
|
|
32
31
|
/>
|
|
33
32
|
</site-search>
|
|
34
33
|
|
|
35
|
-
{
|
|
36
|
-
SEARCH?.enableAISearch === true && (
|
|
37
|
-
<button id="chat-button" popovertarget="stldocs-chat" data-open-modal>
|
|
38
|
-
<Icon name="comment" />
|
|
39
|
-
</button>
|
|
40
|
-
)
|
|
41
|
-
}
|
|
42
|
-
|
|
43
34
|
<style>
|
|
44
35
|
#chat-button {
|
|
45
36
|
background: var(--sl-color-bg-ui);
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
-
import { BASE_PATH, HIGHLIGHT_THEMES
|
|
2
|
+
import { BASE_PATH, HIGHLIGHT_THEMES } from 'virtual:stl-starlight-virtual-module';
|
|
3
3
|
import { parseRoute, generateRoute } from '@stainless-api/docs-ui/routing';
|
|
4
4
|
import { SearchModal } from '@stainless-api/docs-ui/search';
|
|
5
|
-
import { ChatModal } from '@stainless-api/docs-ui/components/chat';
|
|
6
5
|
import * as Markdoc from '@markdoc/markdoc';
|
|
7
6
|
import { createHighlighter } from 'shiki';
|
|
8
7
|
import type { BundledLanguage, BundledTheme, HighlighterGeneric } from 'shiki';
|
|
@@ -102,7 +101,6 @@ export function DocsSearch({ settings, currentPath }: { settings: SearchSettings
|
|
|
102
101
|
<SearchProvider onSelect={handleSelect} pageFind={pageFind} settings={settings}>
|
|
103
102
|
<div className="stldocs-root">
|
|
104
103
|
<SearchModal id="stldocs-search" />
|
|
105
|
-
{SEARCH?.enableAISearch === true && <ChatModal id="stldocs-chat" />}
|
|
106
104
|
</div>
|
|
107
105
|
</SearchProvider>
|
|
108
106
|
</MarkdownProvider>
|
package/plugin/index.ts
CHANGED
|
@@ -221,7 +221,6 @@ async function stlStarlightAstroIntegration(
|
|
|
221
221
|
CONTENT_PANEL_LAYOUT: pluginConfig.contentPanel.layout,
|
|
222
222
|
EXPERIMENTAL_COLLAPSIBLE_SNIPPETS: pluginConfig.experimentalCollapsibleSnippets,
|
|
223
223
|
PROPERTY_SETTINGS: pluginConfig.propertySettings,
|
|
224
|
-
SEARCH: pluginConfig.search,
|
|
225
224
|
ENABLE_CONTEXT_MENU: pluginConfig.contextMenu,
|
|
226
225
|
} satisfies Omit<typeof StlStarlightVirtualModule, 'MIDDLEWARE'>),
|
|
227
226
|
vmMiddlewareExport,
|
|
@@ -108,19 +108,6 @@ export type StainlessStarlightUserConfig = {
|
|
|
108
108
|
*/
|
|
109
109
|
propertySettings?: PropertySettingsType;
|
|
110
110
|
|
|
111
|
-
/**
|
|
112
|
-
* Options to control the documentation site's search functionality
|
|
113
|
-
*/
|
|
114
|
-
search?: {
|
|
115
|
-
/**
|
|
116
|
-
* When set to `true`, the enableAISearch` setting turns on support for
|
|
117
|
-
* LLM-based conversations with the API documentation
|
|
118
|
-
*
|
|
119
|
-
* @default false
|
|
120
|
-
*/
|
|
121
|
-
enableAISearch?: boolean;
|
|
122
|
-
};
|
|
123
|
-
|
|
124
111
|
/**
|
|
125
112
|
* Enable experimental collapsible code snippets. Snippets will be collapsed by default for
|
|
126
113
|
* single-pane and mobile layouts.
|
|
@@ -266,9 +253,6 @@ function normalizeConfig(partial: SomeStainlessStarlightUserConfig, command: Ast
|
|
|
266
253
|
expandDepth: partial.propertySettings?.expandDepth ?? 0,
|
|
267
254
|
includeModelProperties: partial.propertySettings?.includeModelProperties ?? true,
|
|
268
255
|
},
|
|
269
|
-
search: {
|
|
270
|
-
enableAISearch: partial.search?.enableAISearch ?? false,
|
|
271
|
-
},
|
|
272
256
|
contextMenu: partial.contextMenu ?? true,
|
|
273
257
|
};
|
|
274
258
|
|
package/virtual-module.d.ts
CHANGED
|
@@ -2,7 +2,6 @@ declare module 'virtual:stl-starlight-virtual-module' {
|
|
|
2
2
|
import type { CreateShikiHighlighterOptions } from '@astrojs/markdown-remark';
|
|
3
3
|
import type { PropertySettingsType } from '@stainless-api/docs-ui/contexts';
|
|
4
4
|
import type { StlStarlightMiddleware } from '@stainless-api/docs/plugin/MiddlewareTypes';
|
|
5
|
-
import type { StainlessStarlightUserConfig } from './plugin/loadPluginConfig';
|
|
6
5
|
|
|
7
6
|
export const BASE_PATH: string;
|
|
8
7
|
export const CMS_PORT: number;
|
|
@@ -17,7 +16,6 @@ declare module 'virtual:stl-starlight-virtual-module' {
|
|
|
17
16
|
export const EXPERIMENTAL_COLLAPSIBLE_SNIPPETS: boolean | undefined;
|
|
18
17
|
export const PROPERTY_SETTINGS: PropertySettingsType;
|
|
19
18
|
export const MIDDLEWARE: StlStarlightMiddleware;
|
|
20
|
-
export const SEARCH: StainlessStarlightUserConfig['search'];
|
|
21
19
|
export const ENABLE_CONTEXT_MENU: boolean;
|
|
22
20
|
}
|
|
23
21
|
|