| **[VoidZero](https://voidzero.dev)** | The company behind Vite, Vitest, Rolldown, and Oxc. VoidZero has been a long-time sponsor of VitePress. VitePress itself is built on top of this ecosystem of high-performance JavaScript tooling. |
+| 
| **[StackBlitz](https://stackblitz.com)** | Creators of WebContainers and a browser-based development platform. Their technology powers the VitePress playground and provides instant preview releases for our pull requests and commits. |
+| 
| **[Algolia](https://algolia.com)** | An AI-powered search platform that provides fast, scalable search. Algolia powers DocSearch for VitePress. Their team has been a long-time partner in building and maintaining our search integration. |
+| 
| **[BrowserStack](https://browserstack.com)** | A cloud-based testing platform for websites and mobile apps. BrowserStack provides the cross-browser and real-device infrastructure used to ensure VitePress works consistently across all browsers. |
diff --git a/__tests__/e2e/.vitepress/theme/components/CustomLayout.vue b/__tests__/e2e/.vitepress/theme/components/CustomLayout.vue
new file mode 100644
index 00000000..4a42af44
--- /dev/null
+++ b/__tests__/e2e/.vitepress/theme/components/CustomLayout.vue
@@ -0,0 +1,14 @@
+
+
+
+
+
+
+
+
+
+
diff --git a/__tests__/e2e/.vitepress/theme/index.ts b/__tests__/e2e/.vitepress/theme/index.ts
index d2629777..9b5c079c 100644
--- a/__tests__/e2e/.vitepress/theme/index.ts
+++ b/__tests__/e2e/.vitepress/theme/index.ts
@@ -1,10 +1,12 @@
import type { Theme } from 'vitepress'
import DefaultTheme from 'vitepress/theme'
+import CustomLayout from './components/CustomLayout.vue'
import ApiPreference from './components/ApiPreference.vue'
import NavVersion from './components/NavVersion.vue'
export default {
extends: DefaultTheme,
+ Layout: CustomLayout,
enhanceApp({ app }) {
app.component('ApiPreference', ApiPreference)
app.component('NavVersion', NavVersion)
diff --git a/__tests__/e2e/index.md b/__tests__/e2e/index.md
index f35cb331..2805de36 100644
--- a/__tests__/e2e/index.md
+++ b/__tests__/e2e/index.md
@@ -6,6 +6,10 @@ title: VitePress
hero:
name: VitePress
text: Vite & Vue Powered Static Site Generator
+ image:
+ src: /vitepress-logo.svg
+ alt: VitePress
+
actions:
- theme: brand
text: Examples
diff --git a/__tests__/e2e/local-search/local-search.test.ts b/__tests__/e2e/local-search/local-search.test.ts
index 492136b6..9496dc6b 100644
--- a/__tests__/e2e/local-search/local-search.test.ts
+++ b/__tests__/e2e/local-search/local-search.test.ts
@@ -4,7 +4,7 @@ describe('local search', () => {
})
test('exclude content from search results', async () => {
- await page.locator('#local-search button').click()
+ await page.locator('.VPNavBarSearchButton').click()
const input = await page.waitForSelector('input#localsearch-input')
await input.type('local')
diff --git a/__tests__/e2e/public/vitepress-logo.svg b/__tests__/e2e/public/vitepress-logo.svg
new file mode 120000
index 00000000..e2b80355
--- /dev/null
+++ b/__tests__/e2e/public/vitepress-logo.svg
@@ -0,0 +1 @@
+../../../art/vitepress-logo.svg
\ No newline at end of file
diff --git a/__tests__/tsconfig.json b/__tests__/tsconfig.json
index 42258a4e..b8fef70a 100644
--- a/__tests__/tsconfig.json
+++ b/__tests__/tsconfig.json
@@ -5,8 +5,9 @@
"baseUrl": ".",
"types": ["node", "vitest/globals"],
"paths": {
+ "client/*": ["../src/client/*"],
"node/*": ["../src/node/*"],
- "client/*": ["../src/client/*"]
+ "shared/*": ["../src/shared/*"]
}
}
}
diff --git a/__tests__/unit/client/theme-default/support/docsearch.test.ts b/__tests__/unit/client/theme-default/support/docsearch.test.ts
new file mode 100644
index 00000000..4da8f113
--- /dev/null
+++ b/__tests__/unit/client/theme-default/support/docsearch.test.ts
@@ -0,0 +1,196 @@
+import {
+ buildAskAiConfig,
+ hasAskAi,
+ hasKeywordSearch,
+ mergeLangFacetFilters,
+ validateCredentials
+} from 'client/theme-default/support/docsearch'
+
+describe('client/theme-default/support/docsearch', () => {
+ describe('mergeLangFacetFilters', () => {
+ test('adds a lang facet filter when none is provided', () => {
+ expect(mergeLangFacetFilters(undefined, 'en')).toEqual(['lang:en'])
+ })
+
+ test('replaces existing lang facet filters', () => {
+ expect(mergeLangFacetFilters('lang:fr', 'en')).toEqual(['lang:en'])
+ expect(mergeLangFacetFilters(['foo', 'lang:fr'], 'en')).toEqual([
+ 'foo',
+ 'lang:en'
+ ])
+ })
+
+ test('handles nested facet filters (OR conditions)', () => {
+ expect(
+ mergeLangFacetFilters([['tag:foo', 'tag:bar'], 'lang:fr'], 'en')
+ ).toEqual([['tag:foo', 'tag:bar'], 'lang:en'])
+ })
+
+ test('removes empty nested arrays', () => {
+ expect(mergeLangFacetFilters([['lang:fr'], 'other'], 'en')).toEqual([
+ 'other',
+ 'lang:en'
+ ])
+ })
+
+ test('handles multiple lang filters in nested arrays', () => {
+ expect(
+ mergeLangFacetFilters([['lang:fr', 'tag:foo'], 'bar'], 'en')
+ ).toEqual([['tag:foo'], 'bar', 'lang:en'])
+ })
+ })
+
+ describe('hasKeywordSearch', () => {
+ test('returns true when all credentials are provided', () => {
+ expect(
+ hasKeywordSearch({
+ appId: 'app',
+ apiKey: 'key',
+ indexName: 'index'
+ })
+ ).toBe(true)
+ })
+
+ test('returns false when any credential is missing', () => {
+ expect(
+ hasKeywordSearch({
+ appId: undefined,
+ apiKey: 'key',
+ indexName: 'index'
+ })
+ ).toBe(false)
+ expect(
+ hasKeywordSearch({
+ appId: 'app',
+ apiKey: undefined,
+ indexName: 'index'
+ })
+ ).toBe(false)
+ expect(
+ hasKeywordSearch({
+ appId: 'app',
+ apiKey: 'key',
+ indexName: undefined
+ })
+ ).toBe(false)
+ })
+ })
+
+ describe('hasAskAi', () => {
+ test('returns true for valid string assistantId', () => {
+ expect(hasAskAi('assistant123')).toBe(true)
+ })
+
+ test('returns false for empty string assistantId', () => {
+ expect(hasAskAi('')).toBe(false)
+ })
+
+ test('returns true for object with assistantId', () => {
+ expect(hasAskAi({ assistantId: 'assistant123' } as any)).toBe(true)
+ })
+
+ test('returns false for object without assistantId', () => {
+ expect(hasAskAi({ assistantId: null } as any)).toBe(false)
+ expect(hasAskAi({} as any)).toBe(false)
+ })
+
+ test('returns false for undefined', () => {
+ expect(hasAskAi(undefined)).toBe(false)
+ })
+ })
+
+ describe('validateCredentials', () => {
+ test('validates complete credentials', () => {
+ const result = validateCredentials({
+ appId: 'app',
+ apiKey: 'key',
+ indexName: 'index'
+ })
+ expect(result.valid).toBe(true)
+ expect(result.appId).toBe('app')
+ expect(result.apiKey).toBe('key')
+ expect(result.indexName).toBe('index')
+ })
+
+ test('invalidates incomplete credentials', () => {
+ expect(
+ validateCredentials({
+ appId: undefined,
+ apiKey: 'key',
+ indexName: 'index'
+ }).valid
+ ).toBe(false)
+ })
+ })
+
+ describe('buildAskAiConfig', () => {
+ test('builds config from string assistantId', () => {
+ const result = buildAskAiConfig(
+ 'assistant123',
+ {
+ appId: 'app',
+ apiKey: 'key',
+ indexName: 'index'
+ } as any,
+ 'en'
+ )
+ expect(result.assistantId).toBe('assistant123')
+ expect(result.appId).toBe('app')
+ expect(result.apiKey).toBe('key')
+ expect(result.indexName).toBe('index')
+ })
+
+ test('builds config from object with overrides', () => {
+ const result = buildAskAiConfig(
+ {
+ assistantId: 'assistant123',
+ appId: 'custom-app',
+ apiKey: 'custom-key',
+ indexName: 'custom-index'
+ } as any,
+ {
+ appId: 'default-app',
+ apiKey: 'default-key',
+ indexName: 'default-index'
+ } as any,
+ 'en'
+ )
+ expect(result.assistantId).toBe('assistant123')
+ expect(result.appId).toBe('custom-app')
+ expect(result.apiKey).toBe('custom-key')
+ expect(result.indexName).toBe('custom-index')
+ })
+
+ test('merges facet filters with lang', () => {
+ const result = buildAskAiConfig(
+ {
+ assistantId: 'assistant123',
+ searchParameters: {
+ facetFilters: ['tag:docs']
+ }
+ } as any,
+ {
+ appId: 'app',
+ apiKey: 'key',
+ indexName: 'index'
+ } as any,
+ 'en'
+ )
+ expect(result.searchParameters?.facetFilters).toContain('tag:docs')
+ expect(result.searchParameters?.facetFilters).toContain('lang:en')
+ })
+
+ test('always adds lang facet filter to searchParameters', () => {
+ const result = buildAskAiConfig(
+ 'assistant123',
+ {
+ appId: 'app',
+ apiKey: 'key',
+ indexName: 'index'
+ } as any,
+ 'en'
+ )
+ expect(result.searchParameters?.facetFilters).toEqual(['lang:en'])
+ })
+ })
+})
diff --git a/__tests__/unit/client/theme-default/support/utils.test.ts b/__tests__/unit/client/theme-default/support/utils.test.ts
index 880d4232..aefc9b8e 100644
--- a/__tests__/unit/client/theme-default/support/utils.test.ts
+++ b/__tests__/unit/client/theme-default/support/utils.test.ts
@@ -1,4 +1,7 @@
-import { ensureStartingSlash } from 'client/theme-default/support/utils'
+import {
+ ensureStartingSlash,
+ isLinkExternal
+} from 'client/theme-default/support/utils'
describe('client/theme-default/utils', () => {
describe('ensureStartingSlash', () => {
@@ -9,4 +12,22 @@ describe('client/theme-default/utils', () => {
expect(ensureStartingSlash('/path/nested')).toBe('/path/nested')
})
})
+
+ describe('isLinkExternal', () => {
+ test('it detects external links by default', () => {
+ expect(isLinkExternal('https://vite.dev')).toBe(true)
+ expect(isLinkExternal('/guide/')).toBe(false)
+ })
+
+ test('it treats _blank targets as external by default', () => {
+ expect(isLinkExternal('/guide/', '_blank')).toBe(true)
+ })
+
+ test('it allows callers to override external detection', () => {
+ expect(isLinkExternal('https://cn.vite.dev', undefined, false)).toBe(
+ false
+ )
+ expect(isLinkExternal('/guide/', undefined, true)).toBe(true)
+ })
+ })
})
diff --git a/__tests__/unit/node/markdown/plugins/highlight.test.ts b/__tests__/unit/node/markdown/plugins/highlight.test.ts
new file mode 100644
index 00000000..7454dcc1
--- /dev/null
+++ b/__tests__/unit/node/markdown/plugins/highlight.test.ts
@@ -0,0 +1,26 @@
+import { highlight } from 'node/markdown/plugins/highlight'
+
+describe('node/markdown/plugins/highlight', () => {
+ test('passes color replacements through markdown options', async () => {
+ const [render, dispose] = await highlight(
+ { light: 'github-light', dark: 'github-dark' },
+ {
+ colorReplacements: {
+ 'github-light': {
+ '#005cc5': '#000000'
+ }
+ }
+ }
+ )
+
+ try {
+ const html = await render('const a = 1', 'js', '')
+
+ expect(html).toContain('--shiki-light:#000000')
+ expect(html).toContain('--shiki-dark:#79B8FF')
+ expect(html).not.toContain('--shiki-light:#005CC5')
+ } finally {
+ dispose()
+ }
+ })
+})
diff --git a/__tests__/unit/node/markdown/plugins/link.test.ts b/__tests__/unit/node/markdown/plugins/link.test.ts
new file mode 100644
index 00000000..e5e09978
--- /dev/null
+++ b/__tests__/unit/node/markdown/plugins/link.test.ts
@@ -0,0 +1,51 @@
+import { slugify } from '@mdit-vue/shared'
+import { MarkdownItAsync } from 'markdown-it-async'
+import { linkPlugin } from 'node/markdown/plugins/link'
+
+describe('node/markdown/plugins/link', () => {
+ const md = new MarkdownItAsync()
+ linkPlugin(md, {}, '/', slugify)
+
+ test('preserves text-fragment hashes on markdown links', async () => {
+ const html = await md.renderAsync(
+ '[58-61](/resources/server/user#:~:text=58*,time%20authentication%20token)',
+ { cleanUrls: false }
+ )
+
+ expect(html).toContain(
+ 'href="/resources/server/user.html#:~:text=58*,time%20authentication%20token"'
+ )
+ })
+
+ // https://web.dev/articles/text-fragments#mixing_element_and_text_fragments
+ test('preserves mixed element and text-fragment hashes', async () => {
+ const html = await md.renderAsync(
+ '[Section](/guide/getting-started#Hello%20World:~:text=Hello%20World)',
+ { cleanUrls: false }
+ )
+
+ expect(html).toContain(
+ 'href="/guide/getting-started.html#hello-world:~:text=Hello%20World"'
+ )
+ })
+
+ test('continues to normalize regular heading hashes', async () => {
+ const html = await md.renderAsync(
+ '[Section](/guide/getting-started#Hello%20World)',
+ { cleanUrls: false }
+ )
+
+ expect(html).toContain('href="/guide/getting-started.html#hello-world"')
+ })
+
+ test('does not break encoding for text-fragments', async () => {
+ const html = await md.renderAsync(
+ '[Section](/foo?title=Cat&oldid=916388819#:~:text=Claws-,Like%20almost,the%20Felidae%2C,-cats)',
+ { cleanUrls: false }
+ )
+
+ expect(html).toContain(
+ 'href="/foo.html?title=Cat&oldid=916388819#:~:text=Claws-,Like%20almost,the%20Felidae%2C,-cats"'
+ )
+ })
+})
diff --git a/__tests__/unit/node/markdown/plugins/snippet.test.ts b/__tests__/unit/node/markdown/plugins/snippet.test.ts
index aa940784..ba4b343e 100644
--- a/__tests__/unit/node/markdown/plugins/snippet.test.ts
+++ b/__tests__/unit/node/markdown/plugins/snippet.test.ts
@@ -3,7 +3,6 @@ import {
findRegion,
rawPathToToken
} from 'node/markdown/plugins/snippet'
-import { expect } from 'vitest'
const removeEmptyKeys =
+ $
+ {{ command }}
+
+
+
+
+
+
+
+ Copied!
+
- // ...
-
-
+ // ...
+
+ サイドバーがあるときだけ表示
-
- ```
+
+ サイドバーがあるときだけ表示
+
+```
diff --git a/docs/ja/reference/default-theme-edit-link.md b/docs/ja/reference/default-theme-edit-link.md
index 03573944..1edac327 100644
--- a/docs/ja/reference/default-theme-edit-link.md
+++ b/docs/ja/reference/default-theme-edit-link.md
@@ -1,60 +1,64 @@
+---
+description: GitHubやGitLabでページの編集リンクをドキュメントページに表示する方法。
+---
+
# 編集リンク {#edit-link}
## サイトレベルの設定 {#site-level-config}
編集リンクは、GitHub や GitLab などの Git 管理サービスでそのページを編集できるリンクを表示します。有効化するには、設定に `themeConfig.editLink` オプションを追加します。
- ```js
- export default {
- themeConfig: {
- editLink: {
- pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path'
- }
- }
- }
- ```
+```js
+export default {
+ themeConfig: {
+ editLink: {
+ pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path'
+ }
+ }
+}
+```
`pattern` オプションはリンクの URL 構造を定義します。`:path` はページパスに置き換えられます。
また、引数に [`PageData`](./runtime-api#usedata) を受け取り、URL 文字列を返す純粋関数を指定することもできます。
- ```js
- export default {
- themeConfig: {
- editLink: {
- pattern: ({ filePath }) => {
- if (filePath.startsWith('packages/')) {
- return `https://github.com/acme/monorepo/edit/main/${filePath}`
- } else {
- return `https://github.com/acme/monorepo/edit/main/docs/${filePath}`
- }
- }
- }
- }
- }
- ```
+```js
+export default {
+ themeConfig: {
+ editLink: {
+ pattern: ({ filePath }) => {
+ if (filePath.startsWith('packages/')) {
+ return `https://github.com/acme/monorepo/edit/main/${filePath}`
+ } else {
+ return `https://github.com/acme/monorepo/edit/main/docs/${filePath}`
+ }
+ }
+ }
+ }
+}
+```
この関数はブラウザでシリアライズされ実行されるため、副作用を持たず、スコープ外のものへアクセスしないでください。
既定では、ドキュメント下部に「Edit this page」というリンクテキストが表示されます。`text` オプションでこの文言をカスタマイズできます。
- ```js
- export default {
- themeConfig: {
- editLink: {
- pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path',
- text: 'GitHub でこのページを編集'
- }
- }
- }
- ```
+```js
+export default {
+ themeConfig: {
+ editLink: {
+ pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path',
+ text: 'GitHub でこのページを編集'
+ }
+ }
+}
+```
## フロントマターでの設定 {#frontmatter-config}
ページごとに無効化するには、フロントマターで `editLink` オプションを使用します。
- ```yaml
- ---
- editLink: false
- ---
- ```
+```yaml
+---
+editLink: false
+---
+```
diff --git a/docs/ja/reference/default-theme-footer.md b/docs/ja/reference/default-theme-footer.md
index f8226c89..44783ba4 100644
--- a/docs/ja/reference/default-theme-footer.md
+++ b/docs/ja/reference/default-theme-footer.md
@@ -1,3 +1,7 @@
+---
+description: VitePressページ下部に表示されるグローバルフッターの設定方法。
+---
+
# フッター {#footer}
`themeConfig.footer` を設定すると、ページ下部にグローバルフッターが表示されます。
diff --git a/docs/ja/reference/default-theme-home-page.md b/docs/ja/reference/default-theme-home-page.md
index e472a478..ccf11620 100644
--- a/docs/ja/reference/default-theme-home-page.md
+++ b/docs/ja/reference/default-theme-home-page.md
@@ -1,3 +1,7 @@
+---
+description: VitePressデフォルトテーマのホームページレイアウトをヒーローセクション、フィーチャー、カスタムコンテンツで設定する方法。
+---
+
# ホームページ {#home-page}
VitePress のデフォルトテーマにはホームページ用レイアウトが用意されています（[このサイトのトップページ](../) でも使われています）。[フロントマター](./frontmatter-config) に `layout: home` を指定すれば、任意のページで利用できます。
@@ -186,3 +190,4 @@ hero:
npm init
npx vitepress init
```
+````
diff --git a/docs/ja/reference/default-theme-last-updated.md b/docs/ja/reference/default-theme-last-updated.md
index 82dfc6de..51c38374 100644
--- a/docs/ja/reference/default-theme-last-updated.md
+++ b/docs/ja/reference/default-theme-last-updated.md
@@ -1,3 +1,7 @@
+---
+description: Gitコミット履歴に基づいてVitePressページに最終更新日時を表示する方法。
+---
+
# 最終更新日時 {#last-updated}
ページ右下に、コンテンツの最終更新時刻を表示できます。有効化するには、設定に `lastUpdated` オプションを追加します。
diff --git a/docs/ja/reference/default-theme-layout.md b/docs/ja/reference/default-theme-layout.md
index e241d03e..7a6b9059 100644
--- a/docs/ja/reference/default-theme-layout.md
+++ b/docs/ja/reference/default-theme-layout.md
@@ -1,3 +1,7 @@
+---
+description: VitePressデフォルトテーマのdoc、page、homeレイアウトの選択と使い方。
+---
+
# レイアウト {#layout}
ページの [フロントマター](./frontmatter-config) の `layout` オプションでページのレイアウトを選択できます。利用可能なレイアウトは `doc`、`page`、`home` の 3 種類です。何も指定しない場合は `doc` として扱われます。
diff --git a/docs/ja/reference/default-theme-nav.md b/docs/ja/reference/default-theme-nav.md
index 207bf9e9..3ac7ec17 100644
--- a/docs/ja/reference/default-theme-nav.md
+++ b/docs/ja/reference/default-theme-nav.md
@@ -1,3 +1,7 @@
+---
+description: VitePressデフォルトテーマのナビゲーションバーにサイトタイトル、ロゴ、メニューリンクを設定する方法。
+---
+
# ナビゲーション {#nav}
ナビはページ上部に表示されるナビゲーションバーです。サイトタイトル、グローバルメニューリンクなどを含みます。
diff --git a/docs/ja/reference/default-theme-prev-next-links.md b/docs/ja/reference/default-theme-prev-next-links.md
index 7b15d699..5a1e7783 100644
--- a/docs/ja/reference/default-theme-prev-next-links.md
+++ b/docs/ja/reference/default-theme-prev-next-links.md
@@ -1,3 +1,7 @@
+---
+description: VitePressドキュメントページ下部に表示される「前のページ」「次のページ」リンクのカスタマイズ方法。
+---
+
# 前／次リンク {#prev-next-links}
ドキュメントのフッターに表示される「前のページ」「次のページ」のテキストとリンクをカスタマイズできます。サイドバーに表示しているタイトルとは別の文言を使いたい場合や、フッターを無効化したり、サイドバーに含まれていないページへリンクしたい場合に便利です。
diff --git a/docs/ja/reference/default-theme-search.md b/docs/ja/reference/default-theme-search.md
index e15de4ef..e2042f75 100644
--- a/docs/ja/reference/default-theme-search.md
+++ b/docs/ja/reference/default-theme-search.md
@@ -1,5 +1,6 @@
---
outline: deep
+description: VitePressサイトにローカル検索またはAlgolia検索を設定する方法。
---
# 検索 {#search}
@@ -29,6 +30,7 @@ export default defineConfig({
-
+
+
+詳しくは[公式 Algolia ドキュメント](https://docsearch.algolia.com/docs/api#translations)を参照してください。すぐに始めるには、このサイトで使っている翻訳を[GitHub リポジトリ](https://github.com/search?q=repo:vuejs/vitepress+%22function+searchOptions%22&type=code)からコピーすることもできます。
+
+### Algolia Ask AI のサポート {#ask-ai}
+
+**Ask AI** を有効にするには、`options` 内に `askAi` オプション（またはその一部）を指定します。
+
```ts
import { defineConfig } from 'vitepress'
@@ -223,79 +238,15 @@ export default defineConfig({
appId: '...',
apiKey: '...',
indexName: '...',
- locales: {
- zh: {
- placeholder: '搜索文档',
- translations: {
- button: {
- buttonText: '搜索文档',
- buttonAriaLabel: '搜索文档'
- },
- modal: {
- searchBox: {
- clearButtonTitle: '清除查询条件',
- clearButtonAriaLabel: '清除查询条件',
- closeButtonText: '关闭',
- closeButtonAriaLabel: '关闭',
- placeholderText: '搜索文档',
- placeholderTextAskAi: '向 AI 提问：',
- placeholderTextAskAiStreaming: '回答中...',
- searchInputLabel: '搜索',
- backToKeywordSearchButtonText: '返回关键字搜索',
- backToKeywordSearchButtonAriaLabel: '返回关键字搜索'
- },
- startScreen: {
- recentSearchesTitle: '搜索历史',
- noRecentSearchesText: '没有搜索历史',
- saveRecentSearchButtonTitle: '保存至搜索历史',
- removeRecentSearchButtonTitle: '从搜索历史中移除',
- favoriteSearchesTitle: '收藏',
- removeFavoriteSearchButtonTitle: '从收藏中移除',
- recentConversationsTitle: '最近的对话',
- removeRecentConversationButtonTitle: '从历史记录中删除对话'
- },
- errorScreen: {
- titleText: '无法获取结果',
- helpText: '你可能需要检查你的网络连接'
- },
- noResultsScreen: {
- noResultsText: '无法找到相关结果',
- suggestedQueryText: '你可以尝试查询',
- reportMissingResultsText: '你认为该查询应该有结果？',
- reportMissingResultsLinkText: '点击反馈'
- },
- resultsScreen: {
- askAiPlaceholder: '向 AI 提问： '
- },
- askAiScreen: {
- disclaimerText: '答案由 AI 生成，可能不准确，请自行验证。',
- relatedSourcesText: '相关来源',
- thinkingText: '思考中...',
- copyButtonText: '复制',
- copyButtonCopiedText: '已复制！',
- copyButtonTitle: '复制',
- likeButtonTitle: '赞',
- dislikeButtonTitle: '踩',
- thanksForFeedbackText: '感谢你的反馈！',
- preToolCallText: '搜索中...',
- duringToolCallText: '搜索 ',
- afterToolCallText: '已搜索'
- },
- footer: {
- selectText: '选择',
- submitQuestionText: '提交问题',
- selectKeyAriaLabel: 'Enter 键',
- navigateText: '切换',
- navigateUpKeyAriaLabel: '向上箭头',
- navigateDownKeyAriaLabel: '向下箭头',
- closeText: '关闭',
- backToSearchText: '返回搜索',
- closeKeyAriaLabel: 'Esc 键',
- poweredByText: '搜索提供者'
- }
- }
- }
- }
+ // askAi: "あなたのアシスタントID"
+ // または
+ askAi: {
+ // 最低限、Algolia から受け取った assistantId を指定する必要があります
+ assistantId: 'XXXYYY',
+ // 任意の上書き — 省略した場合は上位の appId/apiKey/indexName を再利用
+ // apiKey: '...',
+ // appId: '...',
+ // indexName: '...'
}
}
}
@@ -303,11 +254,13 @@ export default defineConfig({
})
```
-[これらのオプション](https://github.com/vuejs/vitepress/blob/main/types/docsearch.d.ts) は上書きできます。詳細は Algolia の公式ドキュメントを参照してください。
+::: warning 注意
+キーワード検索を既定にして Ask AI を使わない場合は、`askAi` を指定しないでください。
+:::
-### Algolia Ask AI のサポート {#ask-ai}
+### Ask AI サイドパネル {#ask-ai-side-panel}
-**Ask AI** を有効にするには、`options` 内に `askAi` オプション（またはその一部）を指定します。
+DocSearch v4.5+ はオプションの **Ask AI サイドパネル**をサポートしています。有効にすると、デフォルトで **Ctrl/Cmd+I** で開くことができます。[サイドパネル API リファレンス](https://docsearch.algolia.com/docs/sidepanel/api-reference)にオプションの完全なリストがあります。
```ts
import { defineConfig } from 'vitepress'
@@ -320,15 +273,18 @@ export default defineConfig({
appId: '...',
apiKey: '...',
indexName: '...',
- // askAi: "YOUR-ASSISTANT-ID"
- // または
askAi: {
- // 少なくとも Algolia から受け取った assistantId を指定
assistantId: 'XXXYYY',
- // 任意の上書き — 省略時は上位の appId/apiKey/indexName を再利用
- // apiKey: '...',
- // appId: '...',
- // indexName: '...'
+ sidePanel: {
+ // @docsearch/sidepanel-js SidepanelProps API をミラー
+ panel: {
+ variant: 'floating', // または 'inline'
+ side: 'right',
+ width: '360px',
+ expandedWidth: '580px',
+ suggestedQuestions: true
+ }
+ }
}
}
}
@@ -336,116 +292,70 @@ export default defineConfig({
})
```
-::: warning 注意
-キーワード検索を既定にして Ask AI を使わない場合は、`askAi` を指定しないでください。
-:::
+キーボードショートカットを無効にする必要がある場合は、サイドパネルの `keyboardShortcuts` オプションを使用してください：
-Ask AI UI の翻訳は `options.translations.modal.askAiScreen` と `options.translations.resultsScreen` にあります。すべてのキーは[型定義](https://github.com/vuejs/vitepress/blob/main/types/docsearch.d.ts)を参照してください。
+```ts
+import { defineConfig } from 'vitepress'
-### クローラー設定 {#crawler-config}
+export default defineConfig({
+ themeConfig: {
+ search: {
+ provider: 'algolia',
+ options: {
+ appId: '...',
+ apiKey: '...',
+ indexName: '...',
+ askAi: {
+ assistantId: 'XXXYYY',
+ sidePanel: {
+ keyboardShortcuts: {
+ 'Ctrl/Cmd+I': false
+ }
+ }
+ }
+ }
+ }
+ }
+})
+```
-このサイトで使用している設定を元にした例です。
+#### モード (auto / sidePanel / hybrid / modal) {#ask-ai-mode}
+
+VitePress がキーワード検索と Ask AI を統合する方法をオプションで制御できます：
+
+- `mode: 'auto'`（デフォルト）：キーワード検索が設定されている場合は `hybrid` を推論し、それ以外の場合は Ask AI サイドパネルが設定されている場合は `sidePanel` を推論します。
+- `mode: 'sidePanel'`：サイドパネルのみを強制（キーワード検索ボタンを非表示）。
+- `mode: 'hybrid'`：キーワード検索モーダル + Ask AI サイドパネルを有効化（キーワード検索設定が必要）。
+- `mode: 'modal'`：Ask AI を DocSearch モーダル内に保持（サイドパネルを設定した場合でも）。
+
+#### Ask AI のみ（キーワード検索なし） {#ask-ai-only}
+
+**Ask AI サイドパネルのみ**を使用する場合は、トップレベルのキーワード検索設定を省略し、`askAi` の下に認証情報を提供できます：
```ts
-new Crawler({
- appId: '...',
- apiKey: '...',
- rateLimit: 8,
- startUrls: ['https://vitepress.dev/'],
- renderJavaScript: false,
- sitemaps: [],
- exclusionPatterns: [],
- ignoreCanonicalTo: false,
- discoveryPatterns: ['https://vitepress.dev/**'],
- schedule: 'at 05:10 on Saturday',
- actions: [
- {
- indexName: 'vitepress',
- pathsToMatch: ['https://vitepress.dev/**'],
- recordExtractor: ({ $, helpers }) => {
- return helpers.docsearch({
- recordProps: {
- lvl1: '.content h1',
- content: '.content p, .content li',
- lvl0: {
- selectors: 'section.has-active div h2',
- defaultValue: 'Documentation'
- },
- lvl2: '.content h2',
- lvl3: '.content h3',
- lvl4: '.content h4',
- lvl5: '.content h5'
- },
- indexHeadings: true
- })
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+ themeConfig: {
+ search: {
+ provider: 'algolia',
+ options: {
+ mode: 'sidePanel',
+ askAi: {
+ assistantId: 'XXXYYY',
+ appId: '...',
+ apiKey: '...',
+ indexName: '...',
+ sidePanel: true
+ }
}
}
- ],
- initialIndexSettings: {
- vitepress: {
- attributesForFaceting: ['type', 'lang'],
- attributesToRetrieve: ['hierarchy', 'content', 'anchor', 'url'],
- attributesToHighlight: ['hierarchy', 'hierarchy_camel', 'content'],
- attributesToSnippet: ['content:10'],
- camelCaseAttributes: ['hierarchy', 'hierarchy_radio', 'content'],
- searchableAttributes: [
- 'unordered(hierarchy_radio_camel.lvl0)',
- 'unordered(hierarchy_radio.lvl0)',
- 'unordered(hierarchy_radio_camel.lvl1)',
- 'unordered(hierarchy_radio.lvl1)',
- 'unordered(hierarchy_radio_camel.lvl2)',
- 'unordered(hierarchy_radio.lvl2)',
- 'unordered(hierarchy_radio_camel.lvl3)',
- 'unordered(hierarchy_radio.lvl3)',
- 'unordered(hierarchy_radio_camel.lvl4)',
- 'unordered(hierarchy_radio.lvl4)',
- 'unordered(hierarchy_radio_camel.lvl5)',
- 'unordered(hierarchy_radio.lvl5)',
- 'unordered(hierarchy_radio_camel.lvl6)',
- 'unordered(hierarchy_radio.lvl6)',
- 'unordered(hierarchy_camel.lvl0)',
- 'unordered(hierarchy.lvl0)',
- 'unordered(hierarchy_camel.lvl1)',
- 'unordered(hierarchy.lvl1)',
- 'unordered(hierarchy_camel.lvl2)',
- 'unordered(hierarchy.lvl2)',
- 'unordered(hierarchy_camel.lvl3)',
- 'unordered(hierarchy.lvl3)',
- 'unordered(hierarchy_camel.lvl4)',
- 'unordered(hierarchy.lvl4)',
- 'unordered(hierarchy_camel.lvl5)',
- 'unordered(hierarchy.lvl5)',
- 'unordered(hierarchy_camel.lvl6)',
- 'unordered(hierarchy.lvl6)',
- 'content'
- ],
- distinct: true,
- attributeForDistinct: 'url',
- customRanking: [
- 'desc(weight.pageRank)',
- 'desc(weight.level)',
- 'asc(weight.position)'
- ],
- ranking: [
- 'words',
- 'filters',
- 'typo',
- 'attribute',
- 'proximity',
- 'exact',
- 'custom'
- ],
- highlightPreTag: '',
- highlightPostTag: '',
- minWordSizefor1Typo: 3,
- minWordSizefor2Typos: 7,
- allowTyposOnNumericTokens: false,
- minProximity: 1,
- ignorePlurals: true,
- advancedSyntax: true,
- attributeCriteriaComputedByMinProximity: true,
- removeWordsIfNoResults: 'allOptional'
- }
}
})
```
+
+### クローラー設定 {#crawler-config}
+
+このサイトで使用している設定を元にした例です。
+
+<<< @/snippets/algolia-crawler.js
diff --git a/docs/ja/reference/default-theme-sidebar.md b/docs/ja/reference/default-theme-sidebar.md
index ddd87383..1f29e629 100644
--- a/docs/ja/reference/default-theme-sidebar.md
+++ b/docs/ja/reference/default-theme-sidebar.md
@@ -1,3 +1,7 @@
+---
+description: VitePressデフォルトテーマのサイドバーナビゲーションをグループ、折りたたみセクション、複数サイドバーで設定する方法。
+---
+
# サイドバー {#sidebar}
サイドバーはドキュメントの主要なナビゲーションブロックです。[`themeConfig.sidebar`](./default-theme-config#sidebar) でメニューを設定できます。
diff --git a/docs/ja/reference/default-theme-team-page.md b/docs/ja/reference/default-theme-team-page.md
index 5f02d4d0..4de34036 100644
--- a/docs/ja/reference/default-theme-team-page.md
+++ b/docs/ja/reference/default-theme-team-page.md
@@ -1,3 +1,7 @@
+---
+description: VitePress組み込みのチームコンポーネントを使い、メンバープロフィール付きのチームページを作成する方法。
+---
+
-
+
+
diff --git a/src/client/theme-default/components/VPContent.vue b/src/client/theme-default/components/VPContent.vue
index b0eb5fc8..42e11fc8 100644
--- a/src/client/theme-default/components/VPContent.vue
+++ b/src/client/theme-default/components/VPContent.vue
@@ -1,4 +1,5 @@
@@ -18,29 +23,25 @@ const { isHome, hasSidebar } = useLayout()
>
クリックして展開
+ +<<< @/snippets/algolia-i18n.ts + +-
+
+
{{ linkText }}
@@ -105,6 +107,11 @@ defineProps<{
color: var(--vp-c-text-2);
}
+ul.details {
+ list-style-type: disc;
+ padding-left: 14px;
+}
+
.link-text {
padding-top: 8px;
}
diff --git a/src/client/theme-default/components/VPHero.vue b/src/client/theme-default/components/VPHero.vue
index 6d4d8ba9..adb4db47 100644
--- a/src/client/theme-default/components/VPHero.vue
+++ b/src/client/theme-default/components/VPHero.vue
@@ -42,6 +42,7 @@ const { heroImageSlotExists } = inject(
+ >(16) // 16 files
-debouncedWatch(
+watchDebounced(
() => [searchIndex.value, filterText.value, showDetailedList.value] as const,
async ([index, filterTextValue, showDetailedListValue], old, onCleanup) => {
if (old?.[0] !== index) {
@@ -339,8 +329,12 @@ onKeyStroke('Escape', () => {
emit('close')
})
-// Translations
-const defaultTranslations: { modal: ModalTranslations } = {
+/* Translations */
+
+const defaultTranslations: LocalSearchTranslations = {
+ button: {
+ buttonText: 'Search'
+ },
modal: {
displayDetails: 'Display detailed list',
resetButtonTitle: 'Reset search',
@@ -360,7 +354,7 @@ const defaultTranslations: { modal: ModalTranslations } = {
const translate = createSearchTranslate(defaultTranslations)
-// Back
+/* Back */
onMounted(() => {
// Prevents going to previous site
@@ -373,6 +367,7 @@ useEventListener('popstate', (event) => {
})
/** Lock body */
+
const isLocked = useScrollLock(inBrowser ? document.body : null)
onMounted(() => {
@@ -432,7 +427,7 @@ function onMouseMove(e: MouseEvent) {
@submit.prevent=""
>