9.9 KiB
@docsearch/docusaurus-adapter
5.0.0
Major Changes
-
ecd905d: # DocSearch v5-betaDocSearch v5 is a major release that introduces AI-powered answers via Agent Studio, a refreshed search UI, and a modernized package architecture.
Ask AI & Agent Studio
- Agent Studio integration with core tools and dynamic tool calls
- Conversation memory support
- Compatibility with the Algolia MCP search tool, with aggregated MCP search tool calls
- Dynamic index selection for Agent Studio
- Feedback integration, including feedback notes and tags
- Prompt suggestions in keyword search and follow-up prompt suggestions
- Ask AI modal split into its own component and Ask AI transport layer removed
Search UI
- Refreshed v5 UI with improved dark theme, sources panel, and accessibility
- Faceted search with filter chips
- Hit breadcrumbs and result badges
Packaging & architecture
- New
@docsearch/clipackage for MCP setup and search - MCP plugin support
- Split JS bundles for search-only usage and JS-based hybrid mode
- Migrated the build system to tsdown
- Migrated CSS building to LightningCSS
Breaking changes
- Ask AI related props are now nested under a single root
askaioption - The Ask AI transport layer has been removed
Patch Changes
-
ecd905d: feat(v5): General UI styling updates and fixes- New
--docsearch-font-familyvariable, used by the search button, keyboard keys, modal, and sidepanel. It replaces the system font stacks that were duplicated acrosssidepanel.cssandbutton.css, so overriding one variable now themes every DocSearch surface - The search input and modal heading are
1remat every breakpoint (previously0.875remwith a mobile-only override) .DocSearch-Titleusesline-height: 1.5eminstead of0.5emand addsoverflow-wrap: anywhere, so long titles wrap instead of overlapping (#2908)- Hit icon
svgsizing moved into.DocSearch-Hit-icon. The.DocSearch-Hit-icon--smallmodifier is replaced by.DocSearch-Hit-icon--start, which top-aligns the icon; recent conversations use it - The Ask AI button icon centers with
display: inline-flexinstead ofmargin-block-start/align-selfoverrides - Removed the 2px offset on the Ask AI sources action text
SourcesPanelacceptspluralTitleText.titleTextis now the singular label, and the trigger renders{count} {label}AskAiScreenTranslationsandConversationScreenTranslationsexposerelatedSourcesTextPlural- Docusaurus adapter:
theme.SearchModal.askAiScreen.relatedSourcesTextis now the singular "Source", and the newtheme.SearchModal.askAiScreen.relatedSourcesTextPluralprovides "Sources"
- New
-
ecd905d: feat(v5): UI and DX updates- Rename the Ask AI assistantId option to agentId (adapter theme.SearchModal.askAi.assistantId → agentId)
- appId and apiKey moved up into @docsearch/core, so they're configured once and shared
- Removed the indexName prop from the Sidepanel
- Facet defaults can now be read from the index searchParameters
- Restored nested grouping of search results
-
ecd905d: Align Ask AI dynamic indices with Agent Studio completions:askAi.indicesis nowstring[](index names only). UseaskAi.searchParametersfor per-index runtime overrides. -
ecd905d: fix(docusaurus-adapter): Docusaurus styling cleanup -
ecd905d: Align CSS class and animation names with theDocSearch-naming convention.- The
shimmerutility class is nowDocSearch-shimmer - Fixed a typo in
DocSearck-AskAiScreen-MessageContent-Stopped, nowDocSearch-AskAiScreen-MessageContent-Stopped - Keyframes renamed to kebab-case:
shimmerText→shimmer-text,slideDown→slide-down,fadeIn→fade-in - Dark theme selectors use
:root[data-theme='dark']instead ofhtml[data-theme='dark'] - Dropped redundant type qualifiers from
.DocSearch-Hits-paddedand.DocSearch-Hit-Select-Iconselectors, slightly lowering their specificity
If you override these classes or keyframes in custom styles, update your selectors accordingly.
- The
-
Updated dependencies [
ecd905d] -
Updated dependencies [
ecd905d] -
Updated dependencies [
ecd905d] -
Updated dependencies [
ecd905d] -
Updated dependencies [
ecd905d] -
Updated dependencies [
ecd905d] -
Updated dependencies [
ecd905d] -
Updated dependencies [
ecd905d] -
Updated dependencies [
ecd905d] -
Updated dependencies [
ecd905d] -
Updated dependencies [
ecd905d] -
Updated dependencies [
ecd905d] -
Updated dependencies [
ecd905d]- @docsearch/react@5.0.0
- @docsearch/sidepanel@5.0.0
- @docsearch/modal@5.0.0
- @docsearch/core@5.0.0
5.0.0-beta.4
Patch Changes
- Updated dependencies [
ee9fddb]- @docsearch/react@5.0.0-beta.4
- @docsearch/sidepanel@5.0.0-beta.4
- @docsearch/modal@5.0.0-beta.4
- @docsearch/core@5.0.0-beta.4
5.0.0-beta.3
Patch Changes
fe4d0c2: Align Ask AI dynamic indices with Agent Studio completions:askAi.indicesis nowstring[](index names only). UseaskAi.searchParametersfor per-index runtime overrides.c6a1ce1: fix(docusaurus-adapter): Docusaurus styling cleanup- Updated dependencies [
3f74c33] - Updated dependencies [
b33a7f7] - Updated dependencies [
fe4d0c2] - Updated dependencies [
4e44b55] - Updated dependencies [
9a1b3e4] - Updated dependencies [
b28bc84]- @docsearch/core@5.0.0-beta.3
- @docsearch/react@5.0.0-beta.3
- @docsearch/modal@5.0.0-beta.3
- @docsearch/sidepanel@5.0.0-beta.3
5.0.0-beta.2
Patch Changes
-
5eac1fd: feat(v5): General UI styling updates and fixes- New
--docsearch-font-familyvariable, used by the search button, keyboard keys, modal, and sidepanel. It replaces the system font stacks that were duplicated acrosssidepanel.cssandbutton.css, so overriding one variable now themes every DocSearch surface - The search input and modal heading are
1remat every breakpoint (previously0.875remwith a mobile-only override) .DocSearch-Titleusesline-height: 1.5eminstead of0.5emand addsoverflow-wrap: anywhere, so long titles wrap instead of overlapping (#2908)- Hit icon
svgsizing moved into.DocSearch-Hit-icon. The.DocSearch-Hit-icon--smallmodifier is replaced by.DocSearch-Hit-icon--start, which top-aligns the icon; recent conversations use it - The Ask AI button icon centers with
display: inline-flexinstead ofmargin-block-start/align-selfoverrides - Removed the 2px offset on the Ask AI sources action text
SourcesPanelacceptspluralTitleText.titleTextis now the singular label, and the trigger renders{count} {label}AskAiScreenTranslationsandConversationScreenTranslationsexposerelatedSourcesTextPlural- Docusaurus adapter:
theme.SearchModal.askAiScreen.relatedSourcesTextis now the singular "Source", and the newtheme.SearchModal.askAiScreen.relatedSourcesTextPluralprovides "Sources"
- New
-
4f6b5b1: feat(v5): UI and DX updates- Rename the Ask AI assistantId option to agentId (adapter theme.SearchModal.askAi.assistantId → agentId)
- appId and apiKey moved up into @docsearch/core, so they're configured once and shared
- Removed the indexName prop from the Sidepanel
- Facet defaults can now be read from the index searchParameters
- Restored nested grouping of search results
-
Updated dependencies [
5eac1fd] -
Updated dependencies [
4f6b5b1] -
Updated dependencies [
9fe6738]- @docsearch/react@5.0.0-beta.2
- @docsearch/sidepanel@5.0.0-beta.2
- @docsearch/modal@5.0.0-beta.2
- @docsearch/core@5.0.0-beta.2
5.0.0-beta.1
Patch Changes
-
09861c8: Align CSS class and animation names with theDocSearch-naming convention.- The
shimmerutility class is nowDocSearch-shimmer - Fixed a typo in
DocSearck-AskAiScreen-MessageContent-Stopped, nowDocSearch-AskAiScreen-MessageContent-Stopped - Keyframes renamed to kebab-case:
shimmerText→shimmer-text,slideDown→slide-down,fadeIn→fade-in - Dark theme selectors use
:root[data-theme='dark']instead ofhtml[data-theme='dark'] - Dropped redundant type qualifiers from
.DocSearch-Hits-paddedand.DocSearch-Hit-Select-Iconselectors, slightly lowering their specificity
If you override these classes or keyframes in custom styles, update your selectors accordingly.
- The
-
Updated dependencies [
f8e0678] -
Updated dependencies [
09861c8]- @docsearch/react@5.0.0-beta.1
- @docsearch/modal@5.0.0-beta.1
- @docsearch/sidepanel@5.0.0-beta.1
- @docsearch/core@5.0.0-beta.1
5.0.0-beta.0
Major Changes
-
a8ed1ea: # DocSearch v5-betaDocSearch v5 is a major release that introduces AI-powered answers via Agent Studio, a refreshed search UI, and a modernized package architecture.
Ask AI & Agent Studio
- Agent Studio integration with core tools and dynamic tool calls
- Conversation memory support
- Compatibility with the Algolia MCP search tool, with aggregated MCP search tool calls
- Dynamic index selection for Agent Studio
- Feedback integration, including feedback notes and tags
- Prompt suggestions in keyword search and follow-up prompt suggestions
- Ask AI modal split into its own component and Ask AI transport layer removed
Search UI
- Refreshed v5 UI with improved dark theme, sources panel, and accessibility
- Faceted search with filter chips
- Hit breadcrumbs and result badges
Packaging & architecture
- New
@docsearch/clipackage for MCP setup and search - MCP plugin support
- Split JS bundles for search-only usage and JS-based hybrid mode
- Migrated the build system to tsdown
- Migrated CSS building to LightningCSS
Breaking changes
- Ask AI related props are now nested under a single root
askaioption - The Ask AI transport layer has been removed
Patch Changes
- Updated dependencies [
a8ed1ea]- @docsearch/core@5.0.0-beta.0
- @docsearch/modal@5.0.0-beta.0
- @docsearch/react@5.0.0-beta.0
- @docsearch/sidepanel@5.0.0-beta.0