@stainless-api/docs 0.1.0-beta.120 → 0.1.0-beta.121

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @stainless-api/docs
 
+## 0.1.0-beta.121
+
+### Minor Changes
+
+- 9cb2166: Join base path with HEADER_LINKS and TABS
+
+### Patch Changes
+
+- 7701d8f: Clean up console warnings loading DocsSearch markdown renderer
+- Updated dependencies [7701d8f]
+- Updated dependencies [5460e81]
+  - @stainless-api/docs-ui@0.1.0-beta.87
+  - @stainless-api/docs-search@0.1.0-beta.40
+
 ## 0.1.0-beta.120
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stainless-api/docs",
-  "version": "0.1.0-beta.120",
+  "version": "0.1.0-beta.121",
   "publishConfig": {
     "access": "public"
   },
@@ -48,9 +48,9 @@
     "cheerio": "^1.2.0",
     "clsx": "^2.1.1",
     "dotenv": "17.3.1",
-    "lucide-react": "^0.574.0",
+    "lucide-react": "^0.577.0",
     "marked": "^17.0.4",
-    "node-html-parser": "^7.0.2",
+    "node-html-parser": "^7.1.0",
     "rehype-parse": "^9.0.1",
     "rehype-remark": "^10.0.1",
     "remark-gfm": "^4.0.1",
@@ -61,8 +61,8 @@
     "vite-plugin-prebundle-workers": "^0.2.0",
     "web-worker": "^1.5.0",
     "yaml": "^2.8.2",
-    "@stainless-api/docs-search": "0.1.0-beta.39",
-    "@stainless-api/docs-ui": "0.1.0-beta.86",
+    "@stainless-api/docs-search": "0.1.0-beta.40",
+    "@stainless-api/docs-ui": "0.1.0-beta.87",
     "@stainless-api/ui-primitives": "0.1.0-beta.50"
   },
   "devDependencies": {

package/plugin/components/search/SearchIsland.tsx

@@ -1,4 +1,4 @@
-import * as React from 'react';
+import { useMemo } from 'react';
 import { RESOLVED_API_REFERENCE_PATH, HIGHLIGHT_THEMES } from 'virtual:stl-starlight-virtual-module';
 import { parseRoute, generateRoute } from '@stainless-api/docs-ui/routing';
 import { SearchModal } from '@stainless-api/docs-search';
@@ -8,27 +8,28 @@ import type { BundledLanguage, BundledTheme, HighlighterGeneric } from 'shiki';
 
 import {
   DocsProvider,
-  type MarkdownContext,
-  MarkdownProvider,
+  type MarkdownContextValue,
   NavigationProvider,
+  SuspensefulMarkdownProvider,
 } from '@stainless-api/docs-ui/contexts';
 import { ComponentProvider } from '@stainless-api/docs-ui/contexts/component';
 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() {
-  if ($$highlighter === null) {
-    $$highlighter = await createHighlighter({
+declare global {
+  var __docsSearchShikiSingleton: Promise<HighlighterGeneric<BundledLanguage, BundledTheme>> | undefined;
+}
+function getHighlighter() {
+  if (!globalThis.__docsSearchShikiSingleton) {
+    globalThis.__docsSearchShikiSingleton = createHighlighter({
       themes: ['github-dark'],
       langs: ['typescript', 'python', 'go', 'java', 'kotlin', 'ruby'],
     });
   }
-
-  return $$highlighter;
+  return globalThis.__docsSearchShikiSingleton;
 }
 
-async function createMarkdownRenderer(): Promise<MarkdownContext> {
+async function createMarkdownRenderer(): Promise<MarkdownContextValue> {
   const highlighter = await getHighlighter();
   const markdocConfig: Markdoc.Config = {
     nodes: {
@@ -91,7 +92,7 @@ async function createMarkdownRenderer(): Promise<MarkdownContext> {
 }
 
 export function DocsSearch({ settings, currentPath }: { settings: SearchSettings; currentPath: string }) {
-  const markdownRenderer = React.use(createMarkdownRenderer());
+  const rendererPromise = useMemo(() => createMarkdownRenderer(), []);
   const { stainlessPath, language } = parseRoute(RESOLVED_API_REFERENCE_PATH, currentPath);
   // eslint-disable-next-line turbo/no-undeclared-env-vars
   const pageFind = import.meta.env.DEV
@@ -109,13 +110,13 @@ export function DocsSearch({ settings, currentPath }: { settings: SearchSettings
     <DocsProvider spec={null} language={language}>
       <ComponentProvider>
         <NavigationProvider basePath="/" selectedPath={stainlessPath}>
-          <MarkdownProvider {...markdownRenderer}>
+          <SuspensefulMarkdownProvider value={rendererPromise}>
             <SearchProvider onSelect={handleSelect} pageFind={pageFind} settings={settings}>
               <div className="stldocs-root">
                 <SearchModal id="stldocs-search" />
               </div>
             </SearchProvider>
-          </MarkdownProvider>
+          </SuspensefulMarkdownProvider>
         </NavigationProvider>
       </ComponentProvider>
     </DocsProvider>

package/stl-docs/index.ts

@@ -6,7 +6,7 @@ import { disableCalloutSyntaxStarlightPlugin } from './disableCalloutSyntax';
 import type { AstroIntegration } from 'astro';
 
 import { normalizeRedirects, type NormalizedRedirectConfig } from './redirects';
-import { join } from 'path';
+import path from 'node:path';
 import { mkdirSync, writeFileSync } from 'fs';
 import {
   parseStlDocsConfig,
@@ -175,12 +175,18 @@ function stainlessDocsIntegration(
           redirects = normalizeRedirects(astroConfig.redirects);
         }
 
+        const base = astroConfig.base ?? '/';
+        const withBase = (link: string) =>
+          ['http://', 'https://', '//'].some((prefix) => link.startsWith(prefix))
+            ? link
+            : path.posix.join(base, link);
+
         const virtualModules = new Map(
           Object.entries({
             'virtual:stl-docs-virtual-module': buildVirtualModuleString({
-              TABS: config.tabs,
+              TABS: config.tabs.map((tab) => ({ ...tab, link: withBase(tab.link) })),
               SPLIT_TABS_ENABLED: config.splitTabsEnabled,
-              HEADER_LINKS: config.header.links,
+              HEADER_LINKS: config.header.links.map((link) => ({ ...link, link: withBase(link.link) })),
               HEADER_LAYOUT: config.header.layout,
               ENABLE_CLIENT_ROUTER: config.enableClientRouter,
               API_REFERENCE_BASE_PATH: apiReferenceBasePath ?? '/api',
@@ -240,9 +246,9 @@ function stainlessDocsIntegration(
       },
       'astro:build:done': ({ dir }) => {
         if (redirects !== null) {
-          const stainlessDir = join(dir.pathname, '_stainless');
+          const stainlessDir = path.join(dir.pathname, '_stainless');
           mkdirSync(stainlessDir, { recursive: true });
-          const outputPath = join(stainlessDir, 'redirects.json');
+          const outputPath = path.join(stainlessDir, 'redirects.json');
           writeFileSync(outputPath, JSON.stringify(redirects, null, 2), {
             encoding: 'utf-8',
           });