@stainless-api/docs 0.1.0-beta.56 → 0.1.0-beta.58

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @stainless-api/docs
 
+## 0.1.0-beta.58
+
+### Minor Changes
+
+- af090c3: refactor: extract search to @stainless-api/docs-search package
+
+### Patch Changes
+
+- e79d6c3: fix an issue where the search bar would overflow over nav elements
+- 2d372fb: feat: support for stainless docs plugins
+- Updated dependencies [af090c3]
+- Updated dependencies [4cf4aa5]
+- Updated dependencies [8886c7c]
+  - @stainless-api/docs-search@0.1.0-beta.1
+  - @stainless-api/docs-ui@0.1.0-beta.49
+  - @stainless-api/ui-primitives@0.1.0-beta.36
+
+## 0.1.0-beta.57
+
+### Patch Changes
+
+- Updated dependencies [ada37ee]
+  - @stainless-api/docs-ui@0.1.0-beta.48
+
 ## 0.1.0-beta.56
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stainless-api/docs",
-  "version": "0.1.0-beta.56",
+  "version": "0.1.0-beta.58",
   "publishConfig": {
     "access": "public"
   },
@@ -32,14 +32,14 @@
     "vite": ">=6.2.1"
   },
   "dependencies": {
-    "@astrojs/markdown-remark": "^6.3.9",
+    "@astrojs/markdown-remark": "^6.3.10",
     "@astrojs/react": "^4.4.2",
-    "@stainless-api/sdk": "0.1.0-alpha.16",
+    "@stainless-api/sdk": "0.1.0-alpha.19",
     "cheerio": "^1.1.2",
     "clsx": "^2.1.1",
     "dotenv": "17.2.3",
     "get-port": "^7.1.0",
-    "lucide-react": "^0.555.0",
+    "lucide-react": "^0.561.0",
     "marked": "^17.0.1",
     "node-html-parser": "^7.0.1",
     "rehype-parse": "^9.0.1",
@@ -52,8 +52,9 @@
     "vite-plugin-prebundle-workers": "^0.2.0",
     "web-worker": "^1.5.0",
     "yaml": "^2.8.2",
-    "@stainless-api/ui-primitives": "0.1.0-beta.35",
-    "@stainless-api/docs-ui": "0.1.0-beta.47"
+    "@stainless-api/docs-ui": "0.1.0-beta.49",
+    "@stainless-api/docs-search": "0.1.0-beta.1",
+    "@stainless-api/ui-primitives": "0.1.0-beta.36"
   },
   "devDependencies": {
     "@astrojs/check": "^0.9.6",
@@ -61,8 +62,8 @@
     "@types/node": "24.10.1",
     "@types/react": "19.2.7",
     "@types/react-dom": "^19.2.3",
-    "react": "^19.2.1",
-    "react-dom": "^19.2.1",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
     "tsx": "^4.21.0",
     "typescript": "5.9.3",
     "vite": "^6.4.1",

package/plugin/buildAlgoliaIndex.ts

@@ -3,7 +3,7 @@ import Stainless from '@stainless-api/sdk';
 import { createSDKJSON, parseInputs, transformOAS } from './cms/worker';
 import type * as SDKJSON from '@stainless/sdk-json';
 import { Languages } from '@stainless-api/docs-ui/routing';
-import { buildIndex } from '@stainless-api/docs-ui/search/providers/algolia';
+import { buildIndex } from '@stainless-api/docs-search/providers/algolia';
 import type { VersionUserConfig } from './loadPluginConfig';
 import type { AstroIntegrationLogger } from 'astro';
 

package/plugin/components/search/SearchAlgolia.astro

@@ -11,6 +11,7 @@ import { Button } from '@stainless-api/ui-primitives';
     aria-label={Astro.locals.t('search.label')}
     aria-keyshortcuts="Control+K"
     variant="outline"
+    className="stl-algolia-search"
   >
     <Icon name="magnifier" />
     <span class="sl-hidden md:sl-block" aria-hidden="true">{Astro.locals.t('search.label')}</span>
@@ -57,3 +58,11 @@ import { Button } from '@stainless-api/ui-primitives';
     }
   });
 </script>
+
+<style>
+  .stl-algolia-search {
+    max-width: unset;
+    width: unset;
+    flex-grow: 1;
+  }
+</style>

package/plugin/components/search/SearchIsland.tsx

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { BASE_PATH, HIGHLIGHT_THEMES } from 'virtual:stl-starlight-virtual-module';
 import { parseRoute, generateRoute } from '@stainless-api/docs-ui/routing';
-import { SearchModal } from '@stainless-api/docs-ui/search';
+import { SearchModal } from '@stainless-api/docs-search';
 import * as Markdoc from '@markdoc/markdoc';
 import { createHighlighter } from 'shiki';
 import type { BundledLanguage, BundledTheme, HighlighterGeneric } from 'shiki';
@@ -11,10 +11,10 @@ import {
   type MarkdownContext,
   MarkdownProvider,
   NavigationProvider,
-  SearchProvider,
 } from '@stainless-api/docs-ui/contexts';
 import { ComponentProvider } from '@stainless-api/docs-ui/contexts/component';
-import type { SearchSettings } from '@stainless-api/docs-ui/search/types';
+import { SearchProvider } from '@stainless-api/docs-search/context';
+import type { SearchSettings } from '@stainless-api/docs-search/types';
 
 let $$highlighter: HighlighterGeneric<BundledLanguage, BundledTheme> | null = null;
 async function getHighlighter() {

package/stl-docs/components/Header.astro

@@ -82,7 +82,7 @@ const shouldRenderSearch = !!(
 
     @media (min-width: 50rem) {
       .default-tabs-container {
-        min-width: 440px;
+        min-width: 540px;
       }
     }
   }

package/stl-docs/components/pagination/Pagination.astro

@@ -65,6 +65,7 @@ const { prev, next } = (await getPrevNextPage(Astro.locals.starlightRoute, confi
     gap: 8px;
 
     margin-bottom: 2rem;
+    color: inherit; /* stl-ui-not-prose sets color: initial */
 
     a {
       border-radius: var(--stl-ui-pagination-border-radius-inner);

package/stl-docs/index.ts

@@ -74,7 +74,7 @@ function stainlessDocsStarlightIntegration(config: NormalizedStainlessDocsConfig
     componentOverrides.Search = resolveSrcFile('/plugin/components/search/Search.astro');
   }
 
-  plugins.push(...config.starlightCompat.plugins);
+  plugins.push(...config.starlightCompat.plugins, ...config.plugins.map((p) => p(config)));
 
   // TODO: re-add once we figure out what to do with the client router
   // if (config.enableClientRouter) {

package/stl-docs/loadStlDocsConfig.ts

@@ -1,5 +1,5 @@
 import type { StainlessStarlightUserConfig } from '../plugin/loadPluginConfig';
-import type { StarlightUserConfig } from '@astrojs/starlight/types';
+import type { StarlightPlugin, StarlightUserConfig } from '@astrojs/starlight/types';
 import type { ButtonVariant } from '@stainless-api/ui-primitives';
 import type { AnchorHTMLAttributes } from 'react';
 import type starlight from '@astrojs/starlight';
@@ -89,6 +89,11 @@ export type StainlessDocsUserConfig = {
    * @default true
    */
   renderPageDescriptions?: boolean;
+  /**
+   * Stainless Docs plugins.
+   * Each plugin is a function that receives the normalized config and returns a Starlight plugin.
+   */
+  plugins?: ((config: Exclude<NormalizedStainlessDocsConfig, 'plugins'>) => StarlightPlugin)[];
 } & PassThroughStarlightConfigOptions;
 
 type HeaderLayout = 'default' | 'stacked';
@@ -160,6 +165,7 @@ function normalizeConfig(userConfig: StainlessDocsUserConfig) {
     contextMenu: userConfig.contextMenu ?? true,
     expressiveCode: userConfig.expressiveCode,
     renderPageDescriptions: userConfig.renderPageDescriptions ?? true,
+    plugins: userConfig.plugins ?? [],
   };
 
   return configWithDefaults;

package/stl-docs/proseSearchIndexing.ts

@@ -2,7 +2,7 @@ import type { AstroIntegration } from 'astro';
 import { readFile } from 'fs/promises';
 import { getSharedLogger } from '../shared/getSharedLogger';
 import { bold } from '../shared/terminalUtils';
-import { buildProseIndex } from '@stainless-api/docs-ui/search/providers/algolia';
+import { buildProseIndex } from '@stainless-api/docs-search/providers/algolia';
 import * as cheerio from 'cheerio';
 
 function chunkByWords(content: string, chunkSize: number = 30000, chunkOverlap: number = 10) {