@stainless-api/docs 0.1.0-beta.7 → 0.1.0-beta.70

package/CHANGELOG.md

@@ -1,5 +1,559 @@
 # @stainless-api/docs
 
+## 0.1.0-beta.70
+
+### Patch Changes
+
+- Updated dependencies [750c348]
+  - @stainless-api/ui-primitives@0.1.0-beta.41
+  - @stainless-api/docs-search@0.1.0-beta.7
+  - @stainless-api/docs-ui@0.1.0-beta.55
+
+## 0.1.0-beta.69
+
+### Patch Changes
+
+- 67aa6b5: improves UI for algolia search on desktop and mobile
+- bf9bdd4: Remove old/broken mintlify-compat Steps implementation in favor of the new component
+- 68f4528: Adds support for opengraph images
+- Updated dependencies [67aa6b5]
+  - @stainless-api/docs-search@0.1.0-beta.6
+  - @stainless-api/docs-ui@0.1.0-beta.54
+
+## 0.1.0-beta.68
+
+### Patch Changes
+
+- add prose docs vector indexing
+
+## 0.1.0-beta.67
+
+### Patch Changes
+
+- a59d5f7: Pass current page context through as “intent”
+- Updated dependencies [e9567b0]
+  - @stainless-api/ui-primitives@0.1.0-beta.40
+  - @stainless-api/docs-ui@0.1.0-beta.53
+  - @stainless-api/docs-search@0.1.0-beta.5
+
+## 0.1.0-beta.66
+
+### Patch Changes
+
+- af54129: fix: index missing prose docs for search
+
+## 0.1.0-beta.65
+
+### Patch Changes
+
+- 22a19ed: exporting Head component to support custom head implements
+
+## 0.1.0-beta.64
+
+### Patch Changes
+
+- add markdown indexing functionality
+
+## 0.1.0-beta.63
+
+### Patch Changes
+
+- d2e3686: add a success state to the copy markdown action
+- Updated dependencies [5d6e5fa]
+  - @stainless-api/ui-primitives@0.1.0-beta.39
+  - @stainless-api/docs-ui@0.1.0-beta.52
+  - @stainless-api/docs-search@0.1.0-beta.4
+
+## 0.1.0-beta.62
+
+### Patch Changes
+
+- 3c4a030: increase minimum starlight depdendency version
+- cd86726: Fix a crash when stl-starlight plugin isn’t being loaded
+- aa9d333: fixes for markdown rendering when astro integrations override the starlight html entrypoint
+- 07a2c87: Should override ThemeProvider for setting theme within the html head
+  - @stainless-api/docs-search@0.1.0-beta.3
+  - @stainless-api/docs-ui@0.1.0-beta.51
+  - @stainless-api/ui-primitives@0.1.0-beta.38
+
+## 0.1.0-beta.61
+
+### Patch Changes
+
+- 88a9894: patch vite optimizeDeps for docs-ai-chat
+- Updated dependencies [2a79bae]
+  - @stainless-api/ui-primitives@0.1.0-beta.38
+  - @stainless-api/docs-ui@0.1.0-beta.51
+  - @stainless-api/docs-search@0.1.0-beta.3
+
+## 0.1.0-beta.60
+
+### Patch Changes
+
+- 2d00f0d: compatibility with the first alpha version of docs-ai-chat
+- Updated dependencies [2d00f0d]
+  - @stainless-api/docs-ui@0.1.0-beta.50
+  - @stainless-api/ui-primitives@0.1.0-beta.37
+  - @stainless-api/docs-search@0.1.0-beta.2
+
+## 0.1.0-beta.59
+
+### Patch Changes
+
+- 23bbd6d: fix search input layout on default header layout
+
+## 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
+
+- d75a72f: Adds C# language support
+
+### Patch Changes
+
+- Updated dependencies [d75a72f]
+- Updated dependencies [2464347]
+  - @stainless-api/docs-ui@0.1.0-beta.47
+
+## 0.1.0-beta.55
+
+### Patch Changes
+
+- ae56b3c: ensure changeset release commit doesn’t include [skip ci]
+- Updated dependencies [ae56b3c]
+  - @stainless-api/docs-ui@0.1.0-beta.46
+  - @stainless-api/ui-primitives@0.1.0-beta.35
+
+## 0.1.0-beta.54
+
+### Minor Changes
+
+- a70f60c: Adds the title property
+
+### Patch Changes
+
+- 2ebf696: enable trusted publishing
+- Updated dependencies [2ebf696]
+- Updated dependencies [a70f60c]
+  - @stainless-api/docs-ui@0.1.0-beta.45
+  - @stainless-api/ui-primitives@0.1.0-beta.34
+
+## 0.1.0-beta.53
+
+### Patch Changes
+
+- 2e1639a: Updated preview worker and added experimental playgrounds feature.
+- Updated dependencies [239e28c]
+- Updated dependencies [ddc4593]
+- Updated dependencies [2e1639a]
+- Updated dependencies [2e1639a]
+  - @stainless-api/docs-ui@0.1.0-beta.44
+  - @stainless-api/ui-primitives@0.1.0-beta.33
+
+## 0.1.0-beta.52
+
+### Patch Changes
+
+- 72c7604: include default themes in stainlessStarlight plugin
+- Updated dependencies [8a32bbb]
+  - @stainless-api/ui-primitives@0.1.0-beta.32
+  - @stainless-api/docs-ui@0.1.0-beta.43
+
+## 0.1.0-beta.51
+
+### Patch Changes
+
+- 4fc191c: standardize accent border colors
+- Updated dependencies [3d2179f]
+  - @stainless-api/ui-primitives@0.1.0-beta.31
+  - @stainless-api/docs-ui@0.1.0-beta.42
+
+## 0.1.0-beta.50
+
+### Patch Changes
+
+- 6de051d: update vendored preview worker
+
+## 0.1.0-beta.49
+
+### Patch Changes
+
+- Updated dependencies [b9e4b82]
+- Updated dependencies [6d12e06]
+- Updated dependencies [5051795]
+  - @stainless-api/ui-primitives@0.1.0-beta.30
+  - @stainless-api/docs-ui@0.1.0-beta.41
+
+## 0.1.0-beta.48
+
+### Patch Changes
+
+- Updated dependencies [81b5b21]
+- Updated dependencies [ba269f9]
+- Updated dependencies [e2a7098]
+- Updated dependencies [589b13d]
+  - @stainless-api/ui-primitives@0.1.0-beta.29
+  - @stainless-api/docs-ui@0.1.0-beta.40
+
+## 0.1.0-beta.47
+
+### Patch Changes
+
+- 466285c: Fixes for expressive code styles
+  - Ensure expressive code styles are applied to docs sites that do not include API reference
+  - Use correct red & green palettes for ins/del diff annotations
+
+- Updated dependencies [d2d5d51]
+  - @stainless-api/ui-primitives@0.1.0-beta.28
+  - @stainless-api/docs-ui@0.1.0-beta.39
+
+## 0.1.0-beta.46
+
+### Minor Changes
+
+- b61b7c1: New theming system
+
+  A whole new set of design system variables used throughout docs, docs-ui, and ui-primitives
+
+  Improves customizability & uniformness compared to the old set of variables.
+
+### Patch Changes
+
+- Updated dependencies [b61b7c1]
+- Updated dependencies [262f201]
+  - @stainless-api/docs-ui@0.1.0-beta.38
+  - @stainless-api/ui-primitives@0.1.0-beta.27
+
+## 0.1.0-beta.45
+
+### Patch Changes
+
+- 00b33d9: syntax highlighting for markdown renderer
+- fa43cff: json brackets should use muted foreground color
+- c06e5c3: update marked dependency
+- 32d1735: experimental support for collapsible method descriptions
+- Updated dependencies [00b33d9]
+- Updated dependencies [32d1735]
+- Updated dependencies [23254d1]
+  - @stainless-api/ui-primitives@0.1.0-beta.26
+  - @stainless-api/docs-ui@0.1.0-beta.37
+
+## 0.1.0-beta.44
+
+### Patch Changes
+
+- Updated dependencies [38b7030]
+  - @stainless-api/docs-ui@0.1.0-beta.36
+
+## 0.1.0-beta.43
+
+### Patch Changes
+
+- a44a012: Remove debug code
+
+## 0.1.0-beta.42
+
+### Patch Changes
+
+- Updated dependencies [3817ff5]
+- Updated dependencies [391a7ce]
+- Updated dependencies [945d4f3]
+  - @stainless-api/docs-ui@0.1.0-beta.35
+
+## 0.1.0-beta.41
+
+### Patch Changes
+
+- 6557889: temporarily remove experimental AI search feature
+- Updated dependencies [6557889]
+  - @stainless-api/docs-ui@0.1.0-beta.34
+
+## 0.1.0-beta.40
+
+### Patch Changes
+
+- Updated dependencies [8670d73]
+  - @stainless-api/docs-ui@0.1.0-beta.33
+
+## 0.1.0-beta.39
+
+### Patch Changes
+
+- 242deef: fix mobile menu on splash pages
+- Updated dependencies [242deef]
+  - @stainless-api/ui-primitives@0.1.0-beta.25
+  - @stainless-api/docs-ui@0.1.0-beta.32
+
+## 0.1.0-beta.38
+
+### Patch Changes
+
+- Updated dependencies [c28b0a6]
+- Updated dependencies [f23c6bc]
+- Updated dependencies [2cd1b33]
+  - @stainless-api/docs-ui@0.1.0-beta.31
+  - @stainless-api/ui-primitives@0.1.0-beta.24
+
+## 0.1.0-beta.37
+
+### Patch Changes
+
+- 5f14e53: Render page descriptions as part of page header by default
+- Updated dependencies [49e1b93]
+  - @stainless-api/docs-ui@0.1.0-beta.30
+  - @stainless-api/ui-primitives@0.1.0-beta.23
+
+## 0.1.0-beta.36
+
+### Patch Changes
+
+- Updated dependencies [7897575]
+  - @stainless-api/ui-primitives@0.1.0-beta.22
+  - @stainless-api/docs-ui@0.1.0-beta.29
+
+## 0.1.0-beta.35
+
+### Patch Changes
+
+- Updated dependencies [344761e]
+  - @stainless-api/ui-primitives@0.1.0-beta.21
+  - @stainless-api/docs-ui@0.1.0-beta.28
+
+## 0.1.0-beta.34
+
+### Patch Changes
+
+- f5173e9: fix: theme flickering
+
+## 0.1.0-beta.33
+
+### Patch Changes
+
+- 7ef572c: feat: updated dropdowns
+- Updated dependencies [7ef572c]
+  - @stainless-api/docs-ui@0.1.0-beta.27
+  - @stainless-api/ui-primitives@0.1.0-beta.20
+
+## 0.1.0-beta.32
+
+### Patch Changes
+
+- 58040d8: feat: ui primitives updates, cursor support
+- Updated dependencies [58040d8]
+  - @stainless-api/docs-ui@0.1.0-beta.26
+  - @stainless-api/ui-primitives@0.1.0-beta.19
+
+## 0.1.0-beta.31
+
+### Patch Changes
+
+- Updated dependencies [afd1f8e]
+- Updated dependencies [279fa0e]
+  - @stainless-api/docs-ui@0.1.0-beta.25
+
+## 0.1.0-beta.30
+
+### Patch Changes
+
+- Updated dependencies [ab570bc]
+  - @stainless-api/docs-ui@0.1.0-beta.24
+
+## 0.1.0-beta.29
+
+### Patch Changes
+
+- Updated dependencies [279fa0e]
+  - @stainless-api/docs-ui@0.1.0-beta.23
+
+## 0.1.0-beta.28
+
+### Minor Changes
+
+- c635741: Updated worker and fixed docs-ui jsx issue
+
+### Patch Changes
+
+- Updated dependencies [c635741]
+  - @stainless-api/docs-ui@0.1.0-beta.22
+  - @stainless-api/ui-primitives@0.1.0-beta.18
+
+## 0.1.0-beta.27
+
+### Patch Changes
+
+- de189ee: remove max width on site title
+
+## 0.1.0-beta.26
+
+### Patch Changes
+
+- 1517484: fixing font loading, updating nav bar height
+- Updated dependencies [1517484]
+  - @stainless-api/docs-ui@0.1.0-beta.21
+  - @stainless-api/ui-primitives@0.1.0-beta.17
+
+## 0.1.0-beta.25
+
+### Patch Changes
+
+- Updated dependencies [b9ce1b6]
+  - @stainless-api/docs-ui@0.1.0-beta.20
+
+## 0.1.0-beta.24
+
+### Patch Changes
+
+- Updated dependencies [402222a]
+  - @stainless-api/docs-ui@0.1.0-beta.19
+
+## 0.1.0-beta.23
+
+### Patch Changes
+
+- Updated dependencies [2150eee]
+  - @stainless-api/docs-ui@0.1.0-beta.18
+
+## 0.1.0-beta.22
+
+### Patch Changes
+
+- Updated dependencies [f7ba067]
+  - @stainless-api/docs-ui@0.1.0-beta.17
+
+## 0.1.0-beta.21
+
+### Patch Changes
+
+- 41e87cb: fix virtual module imports
+
+## 0.1.0-beta.20
+
+### Patch Changes
+
+- 9cdb24d: Update pagination components, fix search modal
+- Updated dependencies [9cdb24d]
+  - @stainless-api/docs-ui@0.1.0-beta.16
+  - @stainless-api/ui-primitives@0.1.0-beta.16
+
+## 0.1.0-beta.19
+
+### Patch Changes
+
+- 15c003d: fix react peer dependencies
+- Updated dependencies [15c003d]
+  - @stainless-api/docs-ui@0.1.0-beta.15
+  - @stainless-api/ui-primitives@0.1.0-beta.15
+
+## 0.1.0-beta.18
+
+### Patch Changes
+
+- Updated dependencies [0572f60]
+  - @stainless-api/docs-ui@0.1.0-beta.14
+
+## 0.1.0-beta.17
+
+### Patch Changes
+
+- a925bb4: fix markdown icon color in dark mode
+
+## 0.1.0-beta.16
+
+### Patch Changes
+
+- 0618d05: Markdown rendering of prose pages, ai context menu, auth via cli, minor fixes
+- Updated dependencies [0618d05]
+  - @stainless-api/docs-ui@0.1.0-beta.13
+  - @stainless-api/ui-primitives@0.1.0-beta.14
+
+## 0.1.0-beta.15
+
+### Patch Changes
+
+- e35360f: include ui-primitive packages
+- Updated dependencies [e35360f]
+  - @stainless-api/docs-ui@0.1.0-beta.12
+  - @stainless-api/ui-primitives@0.1.0-beta.13
+
+## 0.1.0-beta.14
+
+### Patch Changes
+
+- a529fd4: fix: site title height
+- Updated dependencies [a529fd4]
+  - @stainless-api/docs-ui@0.1.0-beta.11
+  - @stainless-api/ui-primitives@0.1.0-beta.12
+
+## 0.1.0-beta.13
+
+### Patch Changes
+
+- 26a4786: fix: include missing starlight config options
+- Updated dependencies [26a4786]
+  - @stainless-api/docs-ui@0.1.0-beta.10
+  - @stainless-api/ui-primitives@0.1.0-beta.11
+
+## 0.1.0-beta.12
+
+### Patch Changes
+
+- Updated dependencies [3e44a9c]
+  - @stainless-api/ui-primitives@0.1.0-beta.10
+  - @stainless-api/docs-ui@0.1.0-beta.9
+
+## 0.1.0-beta.11
+
+### Patch Changes
+
+- c96f895: Remove css layers, update sidebar styles, add new prose elements
+- Updated dependencies [c96f895]
+  - @stainless-api/docs-ui@0.1.0-beta.8
+  - @stainless-api/ui-primitives@0.1.0-beta.9
+
+## 0.1.0-beta.10
+
+### Patch Changes
+
+- dc059d2: should include option in stl-docs virtual module
+
+## 0.1.0-beta.9
+
+### Patch Changes
+
+- d15a520: fix initialization of dropdown buttons
+- Updated dependencies [d15a520]
+  - @stainless-api/ui-primitives@0.1.0-beta.8
+  - @stainless-api/docs-ui@0.1.0-beta.7
+
+## 0.1.0-beta.8
+
+### Minor Changes
+
+- 917493d: move stainlessDocs into default export
+
 ## 0.1.0-beta.7
 
 ### Patch Changes

package/README.md

@@ -5,7 +5,7 @@
 3. In your Astro config:
 
 ```
-import { stainlessStarlight } from "stl-starlight";
+import { stainlessStarlight } from "@stainless-api/docs";
 ```
 
 4. Run `pnpm astro:sync` to generate astro types

package/eslint-suppressions.json

@@ -0,0 +1,52 @@
+{
+  "plugin/buildAlgoliaIndex.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 2
+    }
+  },
+  "plugin/cms/client.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 1
+    }
+  },
+  "plugin/cms/server.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 4
+    }
+  },
+  "plugin/cms/sidebar-builder.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 1
+    }
+  },
+  "plugin/cms/worker.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 3
+    }
+  },
+  "plugin/components/SnippetCode.tsx": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 1
+    }
+  },
+  "plugin/globalJs/copy.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 3
+    }
+  },
+  "plugin/index.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 1
+    }
+  },
+  "plugin/languages.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 1
+    }
+  },
+  "shared/virtualModule.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 1
+    }
+  }
+}

package/locals.d.ts

@@ -0,0 +1,17 @@
+type SidebarEntry = App.Locals['starlightRoute']['sidebar'][number];
+
+/**
+ * Extending Astro’s `App.Locals` interface
+ */
+declare namespace App {
+  interface Locals {
+    _stlStarlightPage?: {
+      skipRenderingStarlightTitle?: boolean;
+      hasMarkdownRoute?: boolean;
+      fullSidebar?: SidebarEntry[];
+    };
+
+    stainlessProject?: string;
+    language?: import('@stainless-api/docs-ui/routing').DocsLanguage;
+  }
+}