Custom Layout!
+ + +Custom Layout!
+ +Custom Layout!
+ +Custom Layout!
+ +{{ data }}
+```
+
+出力:
+
+```json
+{
+ "hello": "world"
+}
+```
+
+データローダー自体は `data` を直接エクスポートしていないことに気づくでしょう。これは VitePress が裏側で `load()` を呼び出し、その結果を暗黙的に `data` として公開しているためです。
+
+ローダーが非同期でも動作します。
+
+```js
+export default {
+ async load() {
+ // リモートデータを取得
+ return (await fetch('...')).json()
+ }
+}
+```
+
+## ローカルファイルからのデータ {#data-from-local-files}
+
+ローカルファイルに基づいたデータを生成する必要がある場合は、データローダー内で `watch` オプションを使用し、ファイルの変更をホットリロードに反映させることが推奨されます。
+
+`watch` では [glob パターン](https://github.com/mrmlnc/fast-glob#pattern-syntax) を利用して複数ファイルをマッチさせることができ、パターンはローダーファイルからの相対パスで指定できます。`load()` 関数にはマッチしたファイルの絶対パスが渡されます。
+
+以下は CSV ファイルを読み込み [csv-parse](https://github.com/adaltas/node-csv/tree/master/packages/csv-parse/) を使って JSON に変換する例です。このコードはビルド時にのみ実行されるため、CSV パーサーがクライアントに送られることはありません。
+
+```js
+import fs from 'node:fs'
+import { parse } from 'csv-parse/sync'
+
+export default {
+ watch: ['./data/*.csv'],
+ load(watchedFiles) {
+ return watchedFiles.map((file) => {
+ return parse(fs.readFileSync(file, 'utf-8'), {
+ columns: true,
+ skip_empty_lines: true
+ })
+ })
+ }
+}
+```
+
+## `createContentLoader`
+
+コンテンツ中心のサイトを構築する場合、ブログ記事や API ページなどを一覧表示する「アーカイブ」や「インデックス」ページが必要になることがよくあります。これはデータローダー API を使って直接実装できますが、あまりにも一般的なケースなので VitePress では `createContentLoader` というヘルパーが用意されています。
+
+```js [posts.data.js]
+import { createContentLoader } from 'vitepress'
+
+export default createContentLoader('posts/*.md', /* options */)
+```
+
+このヘルパーは [ソースディレクトリ](./routing#source-directory) からの相対 glob パターンを受け取り、`{ watch, load }` を返すデータローダーオブジェクトを生成します。これをデータローダーファイルのデフォルトエクスポートにできます。開発時のパフォーマンスを向上させるために、ファイルの更新時刻に基づくキャッシュも行われます。
+
+このローダーは Markdown ファイルにのみ対応し、それ以外のファイルは無視されます。
+
+読み込まれるデータは `ContentData[]` 型の配列です。
+
+```ts
+interface ContentData {
+ url: string // ページのマッピング URL（例: /posts/hello.html）
+ frontmatter: RecordAll Blog Posts
+-
+
- + {{ post.frontmatter.title }} + by {{ post.frontmatter.author }} + +
デモ
+ + + +-
+
- + {{ todo.text }} + +
-
+
- + {{ todo.text }} + +
` 〜 `` を表示）
+ *
+ * @default 2
+ */
+ level?: number | [number, number] | 'deep'
+
+ /**
+ * アウトラインに表示するタイトル
+ *
+ * @default 'On this page'
+ */
+ label?: string
+ }
+ ```
+
+## socialLinks
+
+- 型: `SocialLink[]`
+
+ナビゲーションにアイコン付きのソーシャルリンクを表示します。
+
+ ```ts
+ export default {
+ themeConfig: {
+ socialLinks: [
+ // simple-icons (https://simpleicons.org/) の任意のアイコンを指定可能
+ { icon: 'github', link: 'https://github.com/vuejs/vitepress' },
+ { icon: 'twitter', link: '...' },
+ // SVG 文字列を渡してカスタムアイコンも可
+ {
+ icon: {
+ svg: ''
+ },
+ link: '...',
+ // アクセシビリティ向けにカスタムラベルも指定可（推奨）
+ ariaLabel: 'cool link'
+ }
+ ]
+ }
+ }
+ ```
+
+ ```ts
+ interface SocialLink {
+ icon: string | { svg: string }
+ link: string
+ ariaLabel?: string
+ }
+ ```
+
+## footer
+
+- 型: `Footer`
+- ページごとに [frontmatter](./frontmatter-config#footer) で上書き可能
+
+フッター設定。メッセージや著作権表示を追加できますが、ページにサイドバーがある場合はデザイン上表示されません。
+
+ ```ts
+ export default {
+ themeConfig: {
+ footer: {
+ message: 'Released under the MIT License.',
+ copyright: 'Copyright © 2019-present Evan You'
+ }
+ }
+ }
+ ```
+
+ ```ts
+ export interface Footer {
+ message?: string
+ copyright?: string
+ }
+ ```
+
+## editLink
+
+- 型: `EditLink`
+- ページごとに [frontmatter](./frontmatter-config#editlink) で上書き可能
+
+「このページを編集」リンクを表示します（GitHub/GitLab など）。詳細は [デフォルトテーマ: 編集リンク](./default-theme-edit-link) を参照。
+
+ ```ts
+ export default {
+ themeConfig: {
+ editLink: {
+ pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path',
+ text: 'Edit this page on GitHub'
+ }
+ }
+ }
+ ```
+
+ ```ts
+ export interface EditLink {
+ pattern: string
+ text?: string
+ }
+ ```
+
+## lastUpdated
+
+- 型: `LastUpdatedOptions`
+
+最終更新の文言と日付フォーマットをカスタマイズします。
+
+ ```ts
+ export default {
+ themeConfig: {
+ lastUpdated: {
+ text: 'Updated at',
+ formatOptions: {
+ dateStyle: 'full',
+ timeStyle: 'medium'
+ }
+ }
+ }
+ }
+ ```
+
+ ```ts
+ export interface LastUpdatedOptions {
+ /**
+ * @default 'Last updated'
+ */
+ text?: string
+
+ /**
+ * @default
+ * { dateStyle: 'short', timeStyle: 'short' }
+ */
+ formatOptions?: Intl.DateTimeFormatOptions & { forceLocale?: boolean }
+ }
+ ```
+
+## algolia
+
+- 型: `AlgoliaSearch`
+
+[Algolia DocSearch](https://docsearch.algolia.com/docs/what-is-docsearch) によるサイト内検索の設定。[デフォルトテーマ: 検索](./default-theme-search) を参照。
+
+ ```ts
+ export interface AlgoliaSearchOptions extends DocSearchProps {
+ locales?: Record>
+ }
+ ```
+
+完全なオプションは[こちら](https://github.com/vuejs/vitepress/blob/main/types/docsearch.d.ts)。
+
+## carbonAds {#carbon-ads}
+
+- 型: `CarbonAdsOptions`
+
+[Carbon Ads](https://www.carbonads.net/) を表示します。
+
+ ```ts
+ export default {
+ themeConfig: {
+ carbonAds: {
+ code: 'your-carbon-code',
+ placement: 'your-carbon-placement'
+ }
+ }
+ }
+ ```
+
+ ```ts
+ export interface CarbonAdsOptions {
+ code: string
+ placement: string
+ }
+ ```
+
+詳細は [デフォルトテーマ: Carbon Ads](./default-theme-carbon-ads) を参照。
+
+## docFooter
+
+- 型: `DocFooter`
+
+前／次リンクの上に表示される文言をカスタマイズします。英語以外のドキュメントで便利。前／次リンク自体をグローバルに無効化することも可能。ページごとに切り替えたい場合は [frontmatter](./default-theme-prev-next-links) を使用します。
+
+ ```ts
+ export default {
+ themeConfig: {
+ docFooter: {
+ prev: 'Pagina prior',
+ next: 'Proxima pagina'
+ }
+ }
+ }
+ ```
+
+ ```ts
+ export interface DocFooter {
+ prev?: string | false
+ next?: string | false
+ }
+ ```
+
+## darkModeSwitchLabel
+
+- 型: `string`
+- 既定値: `Appearance`
+
+ダークモード切替スイッチのラベル（モバイル表示のみ）をカスタマイズします。
+
+## lightModeSwitchTitle
+
+- 型: `string`
+- 既定値: `Switch to light theme`
+
+ホバー時に表示されるライトモード切替のタイトルをカスタマイズします。
+
+## darkModeSwitchTitle
+
+- 型: `string`
+- 既定値: `Switch to dark theme`
+
+ホバー時に表示されるダークモード切替のタイトルをカスタマイズします。
+
+## sidebarMenuLabel
+
+- 型: `string`
+- 既定値: `Menu`
+
+サイドバーメニューのラベル（モバイル表示のみ）をカスタマイズします。
+
+## returnToTopLabel
+
+- 型: `string`
+- 既定値: `Return to top`
+
+トップに戻るボタンのラベル（モバイル表示のみ）をカスタマイズします。
+
+## langMenuLabel
+
+- 型: `string`
+- 既定値: `Change language`
+
+ナビバーの言語切替ボタンの aria-label をカスタマイズします。[i18n](../guide/i18n) を使う場合に有効です。
+
+## skipToContentLabel
+
+- 型: `string`
+- 既定値: `Skip to content`
+
+コンテンツへスキップリンクのラベルをカスタマイズします。キーボード操作時に表示されます。
+
+## externalLinkIcon
+
+- 型: `boolean`
+- 既定値: `false`
+
+Markdown 内の外部リンクの横に外部リンクアイコンを表示するかどうか。
+
+## `useLayout`
+
+ sidebar: Readonly>
+ sidebarGroups: ComputedRef
+ hasSidebar: ComputedRef
+ isSidebarEnabled: ComputedRef
+
+ hasAside: ComputedRef
+ leftAside: ComputedRef
+
+ headers: Readonly>
+ hasLocalNav: ComputedRef
+ }
+ ```
+
+**例:**
+
+ ```vue
+
+
+
+ サイドバーがあるときだけ表示
+
+ ```
diff --git a/docs/ja/reference/default-theme-edit-link.md b/docs/ja/reference/default-theme-edit-link.md
new file mode 100644
index 00000000..03573944
--- /dev/null
+++ b/docs/ja/reference/default-theme-edit-link.md
@@ -0,0 +1,60 @@
+# 編集リンク {#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'
+ }
+ }
+ }
+ ```
+
+`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}`
+ }
+ }
+ }
+ }
+ }
+ ```
+
+この関数はブラウザでシリアライズされ実行されるため、副作用を持たず、スコープ外のものへアクセスしないでください。
+
+既定では、ドキュメント下部に「Edit this page」というリンクテキストが表示されます。`text` オプションでこの文言をカスタマイズできます。
+
+ ```js
+ export default {
+ themeConfig: {
+ editLink: {
+ pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path',
+ text: 'GitHub でこのページを編集'
+ }
+ }
+ }
+ ```
+
+## フロントマターでの設定 {#frontmatter-config}
+
+ページごとに無効化するには、フロントマターで `editLink` オプションを使用します。
+
+ ```yaml
+ ---
+ editLink: false
+ ---
+ ```
diff --git a/docs/ja/reference/default-theme-footer.md b/docs/ja/reference/default-theme-footer.md
new file mode 100644
index 00000000..f8226c89
--- /dev/null
+++ b/docs/ja/reference/default-theme-footer.md
@@ -0,0 +1,55 @@
+# フッター {#footer}
+
+`themeConfig.footer` を設定すると、ページ下部にグローバルフッターが表示されます。
+
+```ts
+export default {
+ themeConfig: {
+ footer: {
+ message: 'Released under the MIT License.',
+ copyright: 'Copyright © 2019-present Evan You'
+ }
+ }
+}
+```
+
+```ts
+export interface Footer {
+ // 著作権表示の直前に表示されるメッセージ
+ message?: string
+
+ // 実際の著作権表記
+ copyright?: string
+}
+```
+
+上記の設定は HTML 文字列にも対応しています。たとえば、フッター内のテキストにリンクを含めたい場合は、次のように設定できます。
+
+```ts
+export default {
+ themeConfig: {
+ footer: {
+ message: 'Released under the MIT License.',
+ copyright: 'Copyright © 2019-present Evan You'
+ }
+ }
+}
+```
+
+::: warning
+`message` と `copyright` は `` 要素内にレンダリングされるため、
+使用できるのはインライン要素のみです。ブロック要素を追加したい場合は、
+[`layout-bottom`](../guide/extending-default-theme#layout-slots) スロットの利用を検討してください。
+:::
+
+なお、[SideBar](./default-theme-sidebar) が表示されている場合はフッターは表示されません。
+
+## フロントマターでの設定 {#frontmatter-config}
+
+ページ単位で無効化するには、フロントマターの `footer` オプションを使用します。
+
+```yaml
+---
+footer: false
+---
+```
diff --git a/docs/ja/reference/default-theme-home-page.md b/docs/ja/reference/default-theme-home-page.md
new file mode 100644
index 00000000..e472a478
--- /dev/null
+++ b/docs/ja/reference/default-theme-home-page.md
@@ -0,0 +1,188 @@
+# ホームページ {#home-page}
+
+VitePress のデフォルトテーマにはホームページ用レイアウトが用意されています（[このサイトのトップページ](../) でも使われています）。[フロントマター](./frontmatter-config) に `layout: home` を指定すれば、任意のページで利用できます。
+
+```yaml
+---
+layout: home
+---
+```
+
+ただし、この指定だけでは多くのことは起きません。`hero` や `features` などの追加オプションを設定して、ホームページにあらかじめ用意された複数の「セクション」を配置できます。
+
+## ヒーローセクション {#hero-section}
+
+ヒーローセクションはホームページの最上部に表示されます。設定例は次のとおりです。
+
+```yaml
+---
+layout: home
+
+hero:
+ name: VitePress
+ text: Vite & Vue powered static site generator.
+ tagline: 概要テキスト...
+ image:
+ src: /logo.png
+ alt: VitePress
+ actions:
+ - theme: brand
+ text: はじめる
+ link: /guide/what-is-vitepress
+ - theme: alt
+ text: GitHub で見る
+ link: https://github.com/vuejs/vitepress
+---
+```
+
+```ts
+interface Hero {
+ // `text` の上に表示される短い文字列。ブランドカラーで表示。
+ // 製品名のような短い文言を想定。
+ name?: string
+
+ // ヒーローセクションのメインテキスト。`h1` として出力。
+ text: string
+
+ // `text` の下に表示されるタグライン。
+ tagline?: string
+
+ // テキストとタグラインの横に表示する画像。
+ image?: ThemeableImage
+
+ // ヒーローに表示するアクションボタン。
+ actions?: HeroAction[]
+}
+
+type ThemeableImage =
+ | string
+ | { src: string; alt?: string }
+ | { light: string; dark: string; alt?: string }
+
+interface HeroAction {
+ // ボタンのカラーテーマ。既定は `brand`。
+ theme?: 'brand' | 'alt'
+
+ // ボタンのラベル。
+ text: string
+
+ // ボタンのリンク先。
+ link: string
+
+ // a 要素の target 属性。
+ target?: string
+
+ // a 要素の rel 属性。
+ rel?: string
+}
+```
+
+### name の色をカスタマイズする {#customizing-the-name-color}
+
+`name` にはブランドカラー（`--vp-c-brand-1`）が使われますが、`--vp-home-hero-name-color` 変数を上書きして色を変更できます。
+
+```css
+:root {
+ --vp-home-hero-name-color: blue;
+}
+```
+
+さらに、`--vp-home-hero-name-background` を組み合わせると、`name` にグラデーションを適用できます。
+
+```css
+:root {
+ --vp-home-hero-name-color: transparent;
+ --vp-home-hero-name-background: -webkit-linear-gradient(120deg, #bd34fe, #41d1ff);
+}
+```
+
+## フィーチャーセクション {#features-section}
+
+フィーチャーセクションでは、ヒーロー直下に任意の数の機能説明を並べられます。フロントマターに `features` オプションを指定して設定します。
+
+各フィーチャーにはアイコン（絵文字または画像）を指定できます。アイコンが画像（svg, png, jpeg など）の場合は、**適切な幅・高さ** を指定してください。必要に応じて説明テキストや実サイズ、ライト／ダーク用の差し替えも指定できます。
+
+```yaml
+---
+layout: home
+
+features:
+ - icon: 🛠️
+ title: いつでもシンプル＆ミニマル
+ details: 概要テキスト...
+ - icon:
+ src: /cool-feature-icon.svg
+ title: もうひとつの便利機能
+ details: 概要テキスト...
+ - icon:
+ dark: /dark-feature-icon.svg
+ light: /light-feature-icon.svg
+ title: さらに別の機能
+ details: 概要テキスト...
+---
+```
+
+```ts
+interface Feature {
+ // 各フィーチャーボックスに表示するアイコン。
+ icon?: FeatureIcon
+
+ // フィーチャーのタイトル。
+ title: string
+
+ // フィーチャーの詳細説明。
+ details: string
+
+ // フィーチャーをクリックしたときのリンク（内部・外部どちらも可）。
+ //
+ // 例: `guide/reference/default-theme-home-page` や `https://example.com`
+ link?: string
+
+ // フィーチャー内に表示するリンクテキスト。
+ // `link` と併用するのが最適。
+ //
+ // 例: `Learn more`, `Visit page` など
+ linkText?: string
+
+ // `link` 用の rel 属性。
+ //
+ // 例: `external`
+ rel?: string
+
+ // `link` 用の target 属性。
+ target?: string
+}
+
+type FeatureIcon =
+ | string
+ | { src: string; alt?: string; width?: string; height: string }
+ | {
+ light: string
+ dark: string
+ alt?: string
+ width?: string
+ height: string
+ }
+```
+
+## Markdown コンテンツ {#markdown-content}
+
+`---` で区切るフロントマターの下に Markdown を書くだけで、ホームページに追加コンテンツを表示できます。
+
+````md
+---
+layout: home
+
+hero:
+ name: VitePress
+ text: Vite & Vue powered static site generator.
+---
+
+## はじめに
+
+`npx` を使えば、すぐに VitePress を始められます！
+
+```sh
+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
new file mode 100644
index 00000000..2c85f2a8
--- /dev/null
+++ b/docs/ja/reference/default-theme-last-updated.md
@@ -0,0 +1,46 @@
+# 最終更新日時 {#last-updated}
+
+ページ右下に、コンテンツの最終更新時刻を表示できます。有効化するには、設定に `lastUpdated` オプションを追加します。
+
+::: info
+VitePress は各ファイルの **直近の Git コミットのタイムスタンプ** を用いて「最終更新」を表示します。これを有効にするには、対象の Markdown ファイルが Git にコミットされている必要があります。
+
+内部的には、各ファイルに対して `git log -1 --pretty="%ai"` を実行してタイムスタンプを取得します。すべてのページで同じ更新時刻が表示される場合、（CI 環境でよくある）**浅いクローン（shallow clone）** により Git の履歴が取得できていない可能性があります。
+
+**GitHub Actions** での修正例は次のとおりです。
+
+```yaml{4}
+- name: Checkout
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+```
+
+他の CI/CD プラットフォームでも同様の設定が用意されています。
+
+もしそのようなオプションが使えない場合は、`package.json` のビルドスクリプトで手動フェッチを前置してください。
+
+```json
+"docs:build": "git fetch --unshallow && vitepress build docs"
+```
+:::
+
+## サイトレベルの設定 {#site-level-config}
+
+```js
+export default {
+ lastUpdated: true
+}
+```
+
+## フロントマターでの設定 {#frontmatter-config}
+
+ページ単位で無効化するには、フロントマターで `lastUpdated` を指定します。
+
+```yaml
+---
+lastUpdated: false
+---
+```
+
+より詳しくは [デフォルトテーマ: 最終更新](./default-theme-config#lastupdated) を参照してください。テーマレベルで truthy な値を設定すると、サイトまたはページで明示的に無効化しない限り、この機能は有効になります。
diff --git a/docs/ja/reference/default-theme-layout.md b/docs/ja/reference/default-theme-layout.md
new file mode 100644
index 00000000..e241d03e
--- /dev/null
+++ b/docs/ja/reference/default-theme-layout.md
@@ -0,0 +1,62 @@
+# レイアウト {#layout}
+
+ページの [フロントマター](./frontmatter-config) の `layout` オプションでページのレイアウトを選択できます。利用可能なレイアウトは `doc`、`page`、`home` の 3 種類です。何も指定しない場合は `doc` として扱われます。
+
+```yaml
+---
+layout: doc
+---
+```
+
+## Doc レイアウト {#doc-layout}
+
+`doc` は既定のレイアウトで、Markdown 全体を「ドキュメント」風にスタイリングします。コンテンツ全体を `vp-doc` という CSS クラスでラップし、その配下の要素にスタイルを適用します。
+
+`p` や `h2` などほぼすべての汎用要素に特別なスタイルが当たります。そのため、Markdown 内にカスタム HTML を追加した場合も、これらのスタイルの影響を受ける点に注意してください。
+
+また、以下のようなドキュメント特有の機能も提供します。これらはこのレイアウトでのみ有効になります。
+
+- 編集リンク（Edit Link）
+- 前後リンク（Prev / Next Link）
+- アウトライン（Outline）
+- [Carbon 広告](./default-theme-carbon-ads)
+
+## Page レイアウト {#page-layout}
+
+`page` は「ブランクページ」として扱われます。Markdown はパースされ、[Markdown 拡張](../guide/markdown) も `doc` と同様に機能しますが、既定のスタイルは適用されません。
+
+このレイアウトでは、VitePress テーマにマークアップを干渉させず、すべてを自分でスタイルできます。独自のカスタムページを作成したい場合に便利です。
+
+なお、このレイアウトでも、ページがサイドバー設定に一致する場合はサイドバーが表示されます。
+
+## Home レイアウト {#home-layout}
+
+`home` はテンプレート化された「ホームページ」を生成します。このレイアウトでは、`hero` や `features` などの追加オプションでコンテンツをさらにカスタマイズできます。詳しくは [デフォルトテーマ: ホームページ](./default-theme-home-page) を参照してください。
+
+## レイアウトなし {#no-layout}
+
+レイアウトを一切適用したくない場合は、フロントマターで `layout: false` を指定します。これは（既定でサイドバー／ナビバー／フッターなしの）完全にカスタマイズ可能なランディングページを作りたい場合に役立ちます。
+
+## カスタムレイアウト {#custom-layout}
+
+カスタムレイアウトを使用することもできます。
+
+```md
+---
+layout: foo
+---
+```
+
+これは、コンテキストに登録された `foo` という名前のコンポーネントを探します。たとえば、`.vitepress/theme/index.ts` でグローバル登録できます。
+
+```ts
+import DefaultTheme from 'vitepress/theme'
+import Foo from './Foo.vue'
+
+export default {
+ extends: DefaultTheme,
+ enhanceApp({ app }) {
+ app.component('foo', Foo)
+ }
+}
+```
diff --git a/docs/ja/reference/default-theme-nav.md b/docs/ja/reference/default-theme-nav.md
new file mode 100644
index 00000000..207bf9e9
--- /dev/null
+++ b/docs/ja/reference/default-theme-nav.md
@@ -0,0 +1,215 @@
+# ナビゲーション {#nav}
+
+ナビはページ上部に表示されるナビゲーションバーです。サイトタイトル、グローバルメニューリンクなどを含みます。
+
+## サイトタイトルとロゴ {#site-title-and-logo}
+
+既定では、ナビには [`config.title`](./site-config#title) の値が表示されます。ナビに表示する文字列を変更したい場合は、`themeConfig.siteTitle` にカスタム文字列を指定します。
+
+```js
+export default {
+ themeConfig: {
+ siteTitle: 'My Custom Title'
+ }
+}
+```
+
+サイトのロゴがある場合は、画像へのパスを渡すと表示できます。ロゴは `public` 直下に配置し、絶対パスで指定してください。
+
+```js
+export default {
+ themeConfig: {
+ logo: '/my-logo.svg'
+ }
+}
+```
+
+ロゴを追加すると、サイトタイトルと並んで表示されます。ロゴだけを表示したい場合は、`siteTitle` を `false` に設定してタイトル文字列を非表示にできます。
+
+```js
+export default {
+ themeConfig: {
+ logo: '/my-logo.svg',
+ siteTitle: false
+ }
+}
+```
+
+ダーク／ライトモードでロゴを切り替えたり、`alt` 属性を付けたい場合は、ロゴにオブジェクトを渡すこともできます。詳細は [`themeConfig.logo`](./default-theme-config#logo) を参照してください。
+
+## ナビゲーションリンク {#navigation-links}
+
+`themeConfig.nav` オプションでナビにリンクを追加できます。
+
+```js
+export default {
+ themeConfig: {
+ nav: [
+ { text: 'Guide', link: '/guide' },
+ { text: 'Config', link: '/config' },
+ { text: 'Changelog', link: 'https://github.com/...' }
+ ]
+ }
+}
+```
+
+`text` はナビに表示される文字列、`link` はクリック時に遷移するリンクです。内部リンクは `.md` 拡張子を付けず、必ず `/` で始めるようにしてください。
+
+`link` には、[`PageData`](./runtime-api#usedata) を受け取ってパスを返す関数を指定することもできます。
+
+ナビリンクはドロップダウンメニューにもできます。リンクオプションに `items` を設定してください。
+
+```js
+export default {
+ themeConfig: {
+ nav: [
+ { text: 'Guide', link: '/guide' },
+ {
+ text: 'Dropdown Menu',
+ items: [
+ { text: 'Item A', link: '/item-1' },
+ { text: 'Item B', link: '/item-2' },
+ { text: 'Item C', link: '/item-3' }
+ ]
+ }
+ ]
+ }
+}
+```
+
+なお、ドロップダウンのタイトル（上の例の `Dropdown Menu`）には `link` は設定できません。ドロップダウンを開くボタンになるためです。
+
+さらに、ドロップダウン内を「セクション」に分けることもできます（入れ子の `items` を使います）。
+
+```js
+export default {
+ themeConfig: {
+ nav: [
+ { text: 'Guide', link: '/guide' },
+ {
+ text: 'Dropdown Menu',
+ items: [
+ {
+ // セクションのタイトル
+ text: 'Section A Title',
+ items: [
+ { text: 'Section A Item A', link: '...' },
+ { text: 'Section B Item B', link: '...' }
+ ]
+ }
+ ]
+ },
+ {
+ text: 'Dropdown Menu',
+ items: [
+ {
+ // タイトルは省略することも可能
+ items: [
+ { text: 'Section A Item A', link: '...' },
+ { text: 'Section B Item B', link: '...' }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+}
+```
+
+### リンクの「アクティブ」状態をカスタマイズ {#customize-link-s-active-state}
+
+現在のページが特定のパス配下にあるとき、該当するナビ項目がハイライトされます。一致させるパスをカスタマイズしたい場合は、`activeMatch` に **正規表現文字列** を指定します。
+
+```js
+export default {
+ themeConfig: {
+ nav: [
+ // ユーザーが `/config/` 配下にいるときにアクティブになる
+ {
+ text: 'Guide',
+ link: '/guide',
+ activeMatch: '/config/'
+ }
+ ]
+ }
+}
+```
+
+::: warning
+`activeMatch` は正規表現 **オブジェクト** ではなく、**文字列** で指定してください。ビルド時のシリアライズの都合で `RegExp` は使用できません。
+:::
+
+### リンクの `target` と `rel` をカスタマイズ {#customize-link-s-target-and-rel-attributes}
+
+既定では、リンクが外部かどうかに応じて VitePress が `target` と `rel` を自動設定します。必要であれば明示的に指定することもできます。
+
+```js
+export default {
+ themeConfig: {
+ nav: [
+ {
+ text: 'Merchandise',
+ link: 'https://www.thegithubshop.com/',
+ target: '_self',
+ rel: 'sponsored'
+ }
+ ]
+ }
+}
+```
+
+## ソーシャルリン� {#social-links}
+
+[`socialLinks`](./default-theme-config#sociallinks) を参照してください。
+
+## カスタムコンポーネント {#custom-components}
+
+`component` オプションを使って、ナビゲーションバーにカスタムコンポーネントを配置できます。`component` には Vue コンポーネント名を指定し、[Theme.enhanceApp](../guide/custom-theme#theme-interface) で **グローバル登録** しておく必要があります。
+
+```js [.vitepress/config.js]
+export default {
+ themeConfig: {
+ nav: [
+ {
+ text: 'My Menu',
+ items: [
+ {
+ component: 'MyCustomComponent',
+ // コンポーネントに渡す任意の props
+ props: {
+ title: 'My Custom Component'
+ }
+ }
+ ]
+ },
+ {
+ component: 'AnotherCustomComponent'
+ }
+ ]
+ }
+}
+```
+
+次に、コンポーネントをグローバル登録します。
+
+```js [.vitepress/theme/index.js]
+import DefaultTheme from 'vitepress/theme'
+
+import MyCustomComponent from './components/MyCustomComponent.vue'
+import AnotherCustomComponent from './components/AnotherCustomComponent.vue'
+
+/** @type {import('vitepress').Theme} */
+export default {
+ extends: DefaultTheme,
+ enhanceApp({ app }) {
+ app.component('MyCustomComponent', MyCustomComponent)
+ app.component('AnotherCustomComponent', AnotherCustomComponent)
+ }
+}
+```
+
+コンポーネントはナビゲーションバー内にレンダリングされます。VitePress は次の追加 props をコンポーネントに提供します。
+
+- `screenMenu`: モバイルのナビメニュー内にあるかどうかを示す任意の boolean
+
+e2e テスト内の例は[こちら](https://github.com/vuejs/vitepress/tree/main/__tests__/e2e/.vitepress)を参照してください。
diff --git a/docs/ja/reference/default-theme-prev-next-links.md b/docs/ja/reference/default-theme-prev-next-links.md
new file mode 100644
index 00000000..7b15d699
--- /dev/null
+++ b/docs/ja/reference/default-theme-prev-next-links.md
@@ -0,0 +1,43 @@
+# 前／次リンク {#prev-next-links}
+
+ドキュメントのフッターに表示される「前のページ」「次のページ」のテキストとリンクをカスタマイズできます。サイドバーに表示しているタイトルとは別の文言を使いたい場合や、フッターを無効化したり、サイドバーに含まれていないページへリンクしたい場合に便利です。
+
+## prev
+
+- 型: `string | false | { text?: string; link?: string }`
+
+- 詳細:
+
+ 前のページへのリンクに表示するテキスト／リンクを指定します。フロントマターで設定しない場合は、サイドバー設定から自動推測されます。
+
+- 例:
+
+ - テキストだけをカスタマイズ:
+
+ ```yaml
+ ---
+ prev: 'Get Started | Markdown'
+ ---
+ ```
+
+ - テキストとリンクの両方をカスタマイズ:
+
+ ```yaml
+ ---
+ prev:
+ text: 'Markdown'
+ link: '/guide/markdown'
+ ---
+ ```
+
+ - 前のページを非表示にする:
+
+ ```yaml
+ ---
+ prev: false
+ ---
+ ```
+
+## next
+
+`prev` と同様ですが、次のページ用の設定です。
diff --git a/docs/ja/reference/default-theme-search.md b/docs/ja/reference/default-theme-search.md
new file mode 100644
index 00000000..e15de4ef
--- /dev/null
+++ b/docs/ja/reference/default-theme-search.md
@@ -0,0 +1,451 @@
+---
+outline: deep
+---
+
+# 検索 {#search}
+
+## ローカル検索 {#local-search}
+
+VitePress は、[minisearch](https://github.com/lucaong/minisearch/) によるブラウザ内インデックスを使った曖昧一致の全文検索をサポートします。有効化するには、`.vitepress/config.ts` で `themeConfig.search.provider` を `'local'` に設定します。
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+ themeConfig: {
+ search: {
+ provider: 'local'
+ }
+ }
+})
+```
+
+表示例:
+
+
+
+代わりに [Algolia DocSearch](#algolia-search) や、次のコミュニティ製プラグインを使うこともできます。
+
+-
+-
+-
+
+### i18n {#local-search-i18n}
+
+多言語検索を行う設定例です。
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+ themeConfig: {
+ search: {
+ provider: 'local',
+ options: {
+ locales: {
+ zh: { // 既定ロケールの文言も翻訳したい場合はこれを `root` に
+ translations: {
+ button: {
+ buttonText: '搜索',
+ buttonAriaLabel: '搜索'
+ },
+ modal: {
+ displayDetails: '显示详细列表',
+ resetButtonTitle: '重置搜索',
+ backButtonTitle: '关闭搜索',
+ noResultsText: '没有结果',
+ footer: {
+ selectText: '选择',
+ selectKeyAriaLabel: '输入',
+ navigateText: '导航',
+ navigateUpKeyAriaLabel: '上箭头',
+ navigateDownKeyAriaLabel: '下箭头',
+ closeText: '关闭',
+ closeKeyAriaLabel: 'esc'
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+})
+```
+
+### miniSearch のオプション {#mini-search-options}
+
+MiniSearch の設定例です。
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+ themeConfig: {
+ search: {
+ provider: 'local',
+ options: {
+ miniSearch: {
+ /**
+ * @type {Pick}
+ */
+ options: {
+ /* ... */
+ },
+ /**
+ * @type {import('minisearch').SearchOptions}
+ * @default
+ * { fuzzy: 0.2, prefix: true, boost: { title: 4, text: 2, titles: 1 } }
+ */
+ searchOptions: {
+ /* ... */
+ }
+ }
+ }
+ }
+ }
+})
+```
+
+詳しくは [MiniSearch のドキュメント](https://lucaong.github.io/minisearch/classes/MiniSearch.MiniSearch.html) を参照してください。
+
+### コンテンツレンダラーのカスタマイズ {#custom-content-renderer}
+
+インデックス前に Markdown コンテンツをレンダリングする関数をカスタマイズできます。
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+ themeConfig: {
+ search: {
+ provider: 'local',
+ options: {
+ /**
+ * @param {string} src
+ * @param {import('vitepress').MarkdownEnv} env
+ * @param {import('markdown-it-async')} md
+ */
+ async _render(src, env, md) {
+ // HTML 文字列を返す
+ }
+ }
+ }
+ }
+})
+```
+
+この関数はクライアント側のサイトデータからは除外されるため、Node.js の API を使用できます。
+
+#### 例: 検索対象からページを除外する {#example-excluding-pages-from-search}
+
+フロントマターに `search: false` を追加すると、そのページを検索対象から除外できます。あるいは次のようにもできます。
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+ themeConfig: {
+ search: {
+ provider: 'local',
+ options: {
+ async _render(src, env, md) {
+ const html = await md.renderAsync(src, env)
+ if (env.frontmatter?.search === false) return ''
+ if (env.relativePath.startsWith('some/path')) return ''
+ return html
+ }
+ }
+ }
+ }
+})
+```
+
+::: warning 注意
+カスタムの `_render` 関数を提供する場合、`search: false` の処理は自分で行う必要があります。また、`env` は `md.renderAsync` の呼び出し前には完全ではないため、`frontmatter` などの任意プロパティのチェックはその後に行ってください。
+:::
+
+#### 例: コンテンツの変換 — 見出しアンカーを追加 {#example-transforming-content-adding-anchors}
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+ themeConfig: {
+ search: {
+ provider: 'local',
+ options: {
+ async _render(src, env, md) {
+ const html = await md.renderAsync(src, env)
+ if (env.frontmatter?.title)
+ return await md.renderAsync(`# ${env.frontmatter.title}`) + html
+ return html
+ }
+ }
+ }
+ }
+})
+```
+
+## Algolia 検索 {#algolia-search}
+
+VitePress は [Algolia DocSearch](https://docsearch.algolia.com/docs/what-is-docsearch) によるサイト検索をサポートします。導入は公式のガイドを参照してください。`.vitepress/config.ts` では最低限次の設定が必要です。
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+ themeConfig: {
+ search: {
+ provider: 'algolia',
+ options: {
+ appId: '...',
+ apiKey: '...',
+ indexName: '...'
+ }
+ }
+ }
+})
+```
+
+### i18n {#algolia-search-i18n}
+
+多言語検索の設定例です。
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+ themeConfig: {
+ search: {
+ provider: 'algolia',
+ options: {
+ 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: '搜索提供者'
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+})
+```
+
+[これらのオプション](https://github.com/vuejs/vitepress/blob/main/types/docsearch.d.ts) は上書きできます。詳細は Algolia の公式ドキュメントを参照してください。
+
+### Algolia Ask AI のサポート {#ask-ai}
+
+**Ask AI** を有効にするには、`options` 内に `askAi` オプション（またはその一部）を指定します。
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+ themeConfig: {
+ search: {
+ provider: 'algolia',
+ options: {
+ appId: '...',
+ apiKey: '...',
+ indexName: '...',
+ // askAi: "YOUR-ASSISTANT-ID"
+ // または
+ askAi: {
+ // 少なくとも Algolia から受け取った assistantId を指定
+ assistantId: 'XXXYYY',
+ // 任意の上書き — 省略時は上位の appId/apiKey/indexName を再利用
+ // apiKey: '...',
+ // appId: '...',
+ // indexName: '...'
+ }
+ }
+ }
+ }
+})
+```
+
+::: warning 注意
+キーワード検索を既定にして Ask AI を使わない場合は、`askAi` を指定しないでください。
+:::
+
+Ask AI UI の翻訳は `options.translations.modal.askAiScreen` と `options.translations.resultsScreen` にあります。すべてのキーは[型定義](https://github.com/vuejs/vitepress/blob/main/types/docsearch.d.ts)を参照してください。
+
+### クローラー設定 {#crawler-config}
+
+このサイトで使用している設定を元にした例です。
+
+```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
+ })
+ }
+ }
+ ],
+ 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'
+ }
+ }
+})
+```
diff --git a/docs/ja/reference/default-theme-sidebar.md b/docs/ja/reference/default-theme-sidebar.md
new file mode 100644
index 00000000..ddd87383
--- /dev/null
+++ b/docs/ja/reference/default-theme-sidebar.md
@@ -0,0 +1,180 @@
+# サイドバー {#sidebar}
+
+サイドバーはドキュメントの主要なナビゲーションブロックです。[`themeConfig.sidebar`](./default-theme-config#sidebar) でメニューを設定できます。
+
+```js
+export default {
+ themeConfig: {
+ sidebar: [
+ {
+ text: 'Guide',
+ items: [
+ { text: 'Introduction', link: '/introduction' },
+ { text: 'Getting Started', link: '/getting-started' },
+ ...
+ ]
+ }
+ ]
+ }
+}
+```
+
+## 基本 {#the-basics}
+
+最もシンプルな構成は、リンクの配列を 1 つ渡す方法です。第 1 階層のアイテムがサイドバーの「セクション」を表します。各セクションは `text`（セクションのタイトル）と、実際のナビゲーションリンクである `items` を持ちます。
+
+```js
+export default {
+ themeConfig: {
+ sidebar: [
+ {
+ text: 'Section Title A',
+ items: [
+ { text: 'Item A', link: '/item-a' },
+ { text: 'Item B', link: '/item-b' },
+ ...
+ ]
+ },
+ {
+ text: 'Section Title B',
+ items: [
+ { text: 'Item C', link: '/item-c' },
+ { text: 'Item D', link: '/item-d' },
+ ...
+ ]
+ }
+ ]
+ }
+}
+```
+
+各 `link` は `/` で始まる実ファイルへのパスを指定します。リンクの末尾を `/` で終わらせると、対応するディレクトリの `index.md` が表示されます。
+
+```js
+export default {
+ themeConfig: {
+ sidebar: [
+ {
+ text: 'Guide',
+ items: [
+ // `/guide/index.md` を表示
+ { text: 'Introduction', link: '/guide/' }
+ ]
+ }
+ ]
+ }
+}
+```
+
+サイドバーのアイテムは、ルートから数えて最大 6 階層まで入れ子にできます。7 階層以上は無視され、表示されません。
+
+```js
+export default {
+ themeConfig: {
+ sidebar: [
+ {
+ text: 'Level 1',
+ items: [
+ {
+ text: 'Level 2',
+ items: [
+ {
+ text: 'Level 3',
+ items: [
+ ...
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+}
+```
+
+## 複数のサイドバー {#multiple-sidebars}
+
+ページのパスに応じて異なるサイドバーを表示できます。たとえば、このサイトのように「Guide」セクションと「Config」セクションでナビゲーションを分けたい場合に便利です。
+
+まず、対象のセクションごとにディレクトリを分けてページを配置します。
+
+```
+.
+├─ guide/
+│ ├─ index.md
+│ ├─ one.md
+│ └─ two.md
+└─ config/
+ ├─ index.md
+ ├─ three.md
+ └─ four.md
+```
+
+次に、各セクション用のサイドバーを設定します。この場合、配列ではなくオブジェクトを渡します。
+
+```js
+export default {
+ themeConfig: {
+ sidebar: {
+ // ユーザーが `guide` ディレクトリ配下にいるときに表示
+ '/guide/': [
+ {
+ text: 'Guide',
+ items: [
+ { text: 'Index', link: '/guide/' },
+ { text: 'One', link: '/guide/one' },
+ { text: 'Two', link: '/guide/two' }
+ ]
+ }
+ ],
+
+ // ユーザーが `config` ディレクトリ配下にいるときに表示
+ '/config/': [
+ {
+ text: 'Config',
+ items: [
+ { text: 'Index', link: '/config/' },
+ { text: 'Three', link: '/config/three' },
+ { text: 'Four', link: '/config/four' }
+ ]
+ }
+ ]
+ }
+ }
+}
+```
+
+## 折りたたみ可能なサイドバーグループ {#collapsible-sidebar-groups}
+
+サイドバーグループに `collapsed` オプションを追加すると、各セクションの開閉トグルが表示されます。
+
+```js
+export default {
+ themeConfig: {
+ sidebar: [
+ {
+ text: 'Section Title A',
+ collapsed: false,
+ items: [...]
+ }
+ ]
+ }
+}
+```
+
+既定ではすべてのセクションが「開いた」状態です。初回表示時に「閉じた」状態にしたい場合は、`collapsed` を `true` に設定します。
+
+```js
+export default {
+ themeConfig: {
+ sidebar: [
+ {
+ text: 'Section Title A',
+ collapsed: true,
+ items: [...]
+ }
+ ]
+ }
+}
+```
diff --git a/docs/ja/reference/default-theme-team-page.md b/docs/ja/reference/default-theme-team-page.md
new file mode 100644
index 00000000..5f02d4d0
--- /dev/null
+++ b/docs/ja/reference/default-theme-team-page.md
@@ -0,0 +1,255 @@
+
+
+# チームページ {#team-page}
+
+チームを紹介したい場合は、Team コンポーネント群を使ってチームページを構成できます。使い方は 2 通りあり、ドキュメントページに埋め込む方法と、専用のチームページを作成する方法があります。
+
+## ページ内にメンバー一覧を表示する {#show-team-members-in-a-page}
+
+任意のページでチームメンバーの一覧を表示するには、`vitepress/theme` からエクスポートされている `` コンポーネントを使用します。
+
+```html
+
+
+# 私たちのチーム
+
+私たちの素晴らしいチームを紹介します。
+
+` コンポーネントには `small` と `medium` の 2 種類のサイズがあります。好みによりますが、ドキュメントページ内で使う場合は `small` が馴染みやすいことが多いでしょう。各メンバーに「説明文」や「スポンサー」ボタンなど、追加のプロパティを付けることもできます。詳細は [``](#vpteammembers) を参照してください。
+
+小規模なチームで専用ページまでは不要な場合や、文脈上の参考として一部のメンバーのみを紹介したい場合は、ドキュメントページへ埋め込む方法が適しています。
+
+メンバーが多い場合や、より広いスペースで紹介したい場合は、[専用のチームページを作成する](#専用のチームページを作成する) ことを検討してください。
+
+## 専用のチームページを作成する {#create-a-full-team-page}
+
+ドキュメントページにメンバーを追加する代わりに、カスタムの [ホームページ](./default-theme-home-page) と同様、専用のチームページを作成することもできます。
+
+まず新しい md ファイルを作成します。ファイル名は任意ですが、ここでは `team.md` とします。このファイルでフロントマターに `layout: page` を設定し、その後 `TeamPage` コンポーネント群を使ってページを構成します。
+
+```html
+---
+layout: page
+---
+
+
+
+
+
+ 私たちのチーム
+
+
+ VitePress の開発は国際的なチームによって主導されています。
+ その一部を以下に紹介します。
+
+
+
+```
+
+専用のチームページを作る際は、必ずすべてのチーム関連コンポーネントを `` でラップしてください。レイアウトや余白などが適切に適用されます。
+
+`` はページタイトルのセクションを追加します。タイトルは `` 見出しになります。`#title` と `#lead` スロットでチームについて説明を書きましょう。
+
+`` はドキュメントページで使う場合と同様に、メンバー一覧を表示します。
+
+### セクションを追加してメンバーを分ける {#add-sections-to-divide-team-members}
+
+チームページに「セクション」を追加できます。たとえば、コアメンバーとコミュニティパートナーなど、役割ごとにメンバーを分けて説明しやすくできます。
+
+そのためには、先ほど作成した `team.md` に `` コンポーネントを追加します。
+
+```html
+---
+layout: page
+---
+
+
+
+
+ 私たちのチーム
+ ...
+
+
+ パートナー
+ ...
+
+
+
+```
+
+`` は `VPTeamPageTitle` と同様に `#title` と `#lead` のスロットを持ち、さらにメンバー表示用の `#members` スロットを備えます。
+
+`#members` スロット内に `` を配置するのを忘れないでください。
+
+## ``
+
+`` コンポーネントは、与えられたメンバー配列を表示します。
+
+```html
+`
+
+専用のチームページを作成する際のルートコンポーネントです。単一のスロットのみを受け取り、渡されたチーム関連コンポーネント全体に適切なスタイルを適用します。
+
+## ``
+
+ページの「タイトル」セクションを追加します。`` の直下に置くのが最適です。`#title` と `#lead` のスロットを受け取ります。
+
+```html
+
+
+
+ 私たちのチーム
+
+
+ VitePress の開発は国際的なチームによって主導されています。
+ その一部を以下に紹介します。
+
+
+
+```
+
+## ``
+
+チームページ内に「セクション」を作成します。`#title`、`#lead`、`#members` の各スロットを受け取ります。`` の中に必要な数だけ追加できます。
+
+```html
+
+ ...
+
+ パートナー
+ Lorem ipsum...
+
+
+
+```
diff --git a/docs/ja/reference/frontmatter-config.md b/docs/ja/reference/frontmatter-config.md
new file mode 100644
index 00000000..e6b8b5ca
--- /dev/null
+++ b/docs/ja/reference/frontmatter-config.md
@@ -0,0 +1,240 @@
+---
+outline: deep
+---
+
+# フロントマター設定 {#frontmatter-config}
+
+フロントマターはページ単位の設定を可能にします。各 Markdown ファイルで、サイト全体やテーマレベルの設定を上書きできます。フロントマターでしか定義できない項目もあります。
+
+使用例:
+
+```md
+---
+title: Docs with VitePress
+editLink: true
+---
+```
+
+Vue の式内では、グローバル `$frontmatter` を介してフロントマターデータにアクセスできます。
+
+```md
+{{ $frontmatter.title }}
+```
+
+## title
+
+- 型: `string`
+
+ページのタイトルです。[config.title](./site-config#title) と同じ意味で、サイトレベルの設定を上書きします。
+
+```yaml
+---
+title: VitePress
+---
+```
+
+## titleTemplate
+
+- 型: `string | boolean`
+
+タイトルのサフィックスです。[config.titleTemplate](./site-config#titletemplate) と同じ意味で、サイトレベルの設定を上書きします。
+
+```yaml
+---
+title: VitePress
+titleTemplate: Vite & Vue powered static site generator
+---
+```
+
+## description
+
+- 型: `string`
+
+ページの説明です。[config.description](./site-config#description) と同じ意味で、サイトレベルの設定を上書きします。
+
+```yaml
+---
+description: VitePress
+---
+```
+
+## head
+
+- 型: `HeadConfig[]`
+
+現在のページに追加で挿入する `` タグを指定します。サイトレベル設定で挿入されたタグの後に追加されます。
+
+```yaml
+---
+head:
+ - - meta
+ - name: description
+ content: hello
+ - - meta
+ - name: keywords
+ content: super duper SEO
+---
+```
+
+```ts
+type HeadConfig =
+ | [string, Record]
+ | [string, Record, string]
+```
+
+## デフォルトテーマ専用 {#default-theme-only}
+
+以下のフロントマター項目は、デフォルトテーマ使用時にのみ適用されます。
+
+### layout
+
+- 型: `doc | home | page`
+- 既定値: `doc`
+
+ページのレイアウトを決めます。
+
+- `doc` — Markdown コンテンツにドキュメント向けの既定スタイルを適用します。
+- `home` — 「ホームページ」用の特別なレイアウト。`hero` や `features` を追加指定して、ランディングページを素早く構築できます。
+- `page` — `doc` と似ていますが、コンテンツにスタイルを適用しません。完全にカスタムなページを作りたい場合に便利です。
+
+```yaml
+---
+layout: doc
+---
+```
+
+### hero {{ theme.footer.copyright }}
+
+```
+
+## `useRoute`
+ /**
+ * ルートが変わる前に呼ばれる。`false` を返すと遷移をキャンセル
+ */
+ onBeforeRouteChange?: (to: string) => Awaitable
+ /**
+ * ページコンポーネントが読み込まれる前（履歴が更新された後）に呼ばれる。
+ * `false` を返すと遷移をキャンセル
+ */
+ onBeforePageLoad?: (to: string) => Awaitable
+ /**
+ * ページコンポーネントが読み込まれた後（更新前）に呼ばれる
+ */
+ onAfterPageLoad?: (to: string) => Awaitable
+ /**
+ * ルートが変わった後に呼ばれる
+ */
+ onAfterRouteChange?: (to: string) => Awaitable
+}
+```
+
+## `withBase` Custom Layout!
+
+
+```
+
+- 関連: [SSR 互換性](../guide/ssr-compat)
+
+## `$frontmatter` /.vitepress/config.[ext]` から解決されます。`` は VitePress の[プロジェクトルート](../guide/routing#root-and-source-directory)で、`[ext]` にはサポートされる拡張子が入ります。TypeScript はそのまま使えます。サポートされる拡張子は `.js`、`.ts`、`.mjs`、`.mts` です。
+
+設定ファイルでは ES Modules 構文の使用を推奨します。設定オブジェクトをデフォルトエクスポートしてください。
+
+```ts
+export default {
+ // アプリレベルの設定
+ lang: 'en-US',
+ title: 'VitePress',
+ description: 'Vite & Vue powered static site generator.',
+ ...
+}
+```
+
+::: details 動的（非同期）設定
+
+設定を動的に生成する必要がある場合は、関数をデフォルトエクスポートすることもできます。例:
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default async () => {
+ const posts = await (await fetch('https://my-cms.com/blog-posts')).json()
+
+ return defineConfig({
+ // アプリレベル設定
+ lang: 'en-US',
+ title: 'VitePress',
+ description: 'Vite & Vue powered static site generator.',
+
+ // テーマレベル設定
+ themeConfig: {
+ sidebar: [
+ ...posts.map((post) => ({
+ text: post.name,
+ link: `/posts/${post.name}`
+ }))
+ ]
+ }
+ })
+}
+```
+
+トップレベル `await` も使用できます。例:
+
+```ts
+import { defineConfig } from 'vitepress'
+
+const posts = await (await fetch('https://my-cms.com/blog-posts')).json()
+
+export default defineConfig({
+ // アプリレベル設定
+ lang: 'en-US',
+ title: 'VitePress',
+ description: 'Vite & Vue powered static site generator.',
+
+ // テーマレベル設定
+ themeConfig: {
+ sidebar: [
+ ...posts.map((post) => ({
+ text: post.name,
+ link: `/posts/${post.name}`
+ }))
+ ]
+ }
+})
+```
+
+:::
+
+### 設定のインテリセンス {#config-intellisense}
+
+`defineConfig` ヘルパーを使うと、TypeScript による補完が効きます。対応 IDE であれば、JavaScript と TypeScript のどちらでも動作します。
+
+```js
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+ // ...
+})
+```
+
+### 型付きのテーマ設定 {#typed-theme-config}
+
+デフォルトでは、`defineConfig` はデフォルトテーマのテーマ設定型を想定します。
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+ themeConfig: {
+ // 型は `DefaultTheme.Config`
+ }
+})
+```
+
+カスタムテーマを使用しており、そのテーマ設定に型チェックを効かせたい場合は、代わりに `defineConfigWithTheme` を使い、ジェネリクスでカスタムテーマの設定型を渡してください。
+
+```ts
+import { defineConfigWithTheme } from 'vitepress'
+import type { ThemeConfig } from 'your-theme'
+
+export default defineConfigWithTheme({
+ themeConfig: {
+ // 型は `ThemeConfig`
+ }
+})
+```
+
+### Vite・Vue・Markdown の設定 {#vite-vue-markdown-config}
+
+- **Vite**
+
+ Vite の設定は VitePress 設定の [vite](#vite) オプションで行えます。別途 Vite の設定ファイルを作る必要はありません。
+
+- **Vue**
+
+ VitePress には公式の Vue プラグイン（[@vitejs/plugin-vue](https://github.com/vitejs/vite-plugin-vue)）が同梱されています。オプションは VitePress 設定の [vue](#vue) から指定できます。
+
+- **Markdown**
+
+ 既定の [Markdown-It](https://github.com/markdown-it/markdown-it) インスタンスは、VitePress 設定の [markdown](#markdown) オプションでカスタマイズできます。
+
+## サイトメタデータ {#site-metadata}
+
+### title
+
+- 型: `string`
+- 既定値: `VitePress`
+- ページ単位での上書き: [frontmatter](./frontmatter-config#title)
+
+サイトのタイトル。デフォルトテーマではナビバーに表示されます。
+
+[`titleTemplate`](#titletemplate) を定義していない場合、個々のページタイトルの既定のサフィックスとしても使われます。各ページの最終タイトルは、そのページの最初の `` 見出しのテキストに、グローバルの `title` をサフィックスとして結合したものになります。次の設定とページ内容の例:
+
+```ts
+export default {
+ title: 'My Awesome Site'
+}
+```
+
+```md
+# Hello
+```
+
+このページのタイトルは `Hello | My Awesome Site` になります。
+
+### titleTemplate
+
+- 型: `string | boolean`
+- ページ単位での上書き: [frontmatter](./frontmatter-config#titletemplate)
+
+各ページタイトルのサフィックス、またはタイトル全体のカスタマイズができます。例:
+
+```ts
+export default {
+ title: 'My Awesome Site',
+ titleTemplate: 'Custom Suffix'
+}
+```
+
+```md
+# Hello
+```
+
+このページのタイトルは `Hello | Custom Suffix` になります。
+
+タイトルの描画方法を完全にカスタマイズするには、`titleTemplate` 内で `:title` シンボルを使います。
+
+```ts
+export default {
+ titleTemplate: ':title - Custom Suffix'
+}
+```
+
+ここで `:title` はページ先頭の `` から推論されたテキストに置き換えられます。先ほどの例では `Hello - Custom Suffix` になります。
+
+`false` を設定するとタイトルのサフィックスを無効にできます。
+
+### description
+
+- 型: `string`
+- 既定値: `A VitePress site`
+- ページ単位での上書き: [frontmatter](./frontmatter-config#description)
+
+サイトの説明。ページの HTML に `` タグとして出力されます。
+
+```ts
+export default {
+ description: 'A VitePress site'
+}
+```
+
+### head
+
+- 型: `HeadConfig[]`
+- 既定値: `[]`
+- ページ単位での追加: [frontmatter](./frontmatter-config#head)
+
+ページ HTML の `` に追加で出力する要素。ユーザーが追加したタグは、VitePress のタグの後、`` の直前にレンダリングされます。
+
+```ts
+type HeadConfig =
+ | [string, Record]
+ | [string, Record, string]
+```
+
+#### 例: favicon を追加 {#example-adding-a-favicon}
+
+```ts
+export default {
+ head: [['link', { rel: 'icon', href: '/favicon.ico' }]]
+} // favicon.ico は public に配置。base を設定している場合は /base/favicon.ico を利用
+
+/* 出力結果:
+
+*/
+```
+
+#### 例: Google Fonts を追加 {#example-adding-google-fonts}
+
+```ts
+export default {
+ head: [
+ [
+ 'link',
+ { rel: 'preconnect', href: 'https://fonts.googleapis.com' }
+ ],
+ [
+ 'link',
+ { rel: 'preconnect', href: 'https://fonts.gstatic.com', crossorigin: '' }
+ ],
+ [
+ 'link',
+ { href: 'https://fonts.googleapis.com/css2?family=Roboto&display=swap', rel: 'stylesheet' }
+ ]
+ ]
+}
+
+/* 出力結果:
+
+
+
+*/
+```
+
+#### 例: Service Worker を登録 {#example-registering-a-service-worker}
+
+```ts
+export default {
+ head: [
+ [
+ 'script',
+ { id: 'register-sw' },
+ `;(() => {
+ if ('serviceWorker' in navigator) {
+ navigator.serviceWorker.register('/sw.js')
+ }
+ })()`
+ ]
+ ]
+}
+
+/* 出力結果:
+
+*/
+```
+
+#### 例: Google Analytics を使用 {#example-using-google-analytics}
+
+```ts
+export default {
+ head: [
+ [
+ 'script',
+ { async: '', src: 'https://www.googletagmanager.com/gtag/js?id=TAG_ID' }
+ ],
+ [
+ 'script',
+ {},
+ `window.dataLayer = window.dataLayer || [];
+ function gtag(){dataLayer.push(arguments);}
+ gtag('js', new Date());
+ gtag('config', 'TAG_ID');`
+ ]
+ ]
+}
+
+/* 出力結果:
+
+
+*/
+```
+
+### lang
+
+- 型: `string`
+- 既定値: `en-US`
+
+サイトの言語属性。ページ HTML の `` として出力されます。
+
+```ts
+export default {
+ lang: 'en-US'
+}
+```
+
+### base
+
+- 型: `string`
+- 既定値: `/`
+
+サイトをデプロイするベース URL。GitHub Pages などサブパス配下にデプロイする場合に設定が必要です。たとえば `https://foo.github.io/bar/` にデプロイする場合、`base` は `'/bar/'` にします。先頭と末尾は必ずスラッシュにしてください。
+
+`/` で始まる他のオプション内の URL には、この `base` が自動的に付与されます。1 回設定すれば十分です。
+
+```ts
+export default {
+ base: '/base/'
+}
+```
+
+## ルーティング {#routing}
+
+### cleanUrls
+
+- 型: `boolean`
+- 既定値: `false`
+
+`true` にすると、URL の末尾の `.html` を削除します。あわせて [クリーン URL の生成](../guide/routing#generating-clean-url) も参照してください。
+
+::: warning サーバ設定が必要
+ホスティング環境によっては追加の設定が必要です。`/foo` へのアクセス時に **リダイレクトなしで** `/foo.html` を返せるサーバ設定が必要です。
+:::
+
+### rewrites
+
+- 型: `Record`
+
+ディレクトリと URL のカスタム対応を定義します。詳しくは [ルーティング: ルートのリライト](../guide/routing#route-rewrites) を参照。
+
+```ts
+export default {
+ rewrites: {
+ 'source/:page': 'destination/:page'
+ }
+}
+```
+
+## ビルド {#build}
+
+### srcDir
+
+- 型: `string`
+- 既定値: `.`
+
+Markdown ページを置くディレクトリ（プロジェクトルートからの相対パス）。[ルートとソースディレクトリ](../guide/routing#root-and-source-directory) も参照。
+
+```ts
+export default {
+ srcDir: './src'
+}
+```
+
+### srcExclude
+
+- 型: `string[]`
+- 既定値: `undefined`
+
+ソースとして除外したい Markdown ファイルにマッチする [glob パターン](https://github.com/mrmlnc/fast-glob#pattern-syntax)。
+
+```ts
+export default {
+ srcExclude: ['**/README.md', '**/TODO.md']
+}
+```
+
+### outDir
+
+- 型: `string`
+- 既定値: `./.vitepress/dist`
+
+ビルド出力先（[プロジェクトルート](../guide/routing#root-and-source-directory) からの相対パス）。
+
+```ts
+export default {
+ outDir: '../public'
+}
+```
+
+### assetsDir
+
+- 型: `string`
+- 既定値: `assets`
+
+生成されるアセットを配置するサブディレクトリ名。パスは [`outDir`](#outdir) の内部で、相対解決されます。
+
+```ts
+export default {
+ assetsDir: 'static'
+}
+```
+
+### cacheDir
+
+- 型: `string`
+- 既定値: `./.vitepress/cache`
+
+キャッシュファイル用ディレクトリ（[プロジェクトルート](../guide/routing#root-and-source-directory) からの相対パス）。参考: [cacheDir](https://vitejs.dev/config/shared-options.html#cachedir)
+
+```ts
+export default {
+ cacheDir: './.vitepress/.vite'
+}
+```
+
+### ignoreDeadLinks
+
+- 型: `boolean | 'localhostLinks' | (string | RegExp | ((link: string, source: string) => boolean))[]`
+- 既定値: `false`
+
+`true` にすると、デッドリンクがあってもビルド失敗にしません。
+
+`'localhostLinks'` にすると、`localhost` へのリンクはチェック対象外にしつつ、その他のデッドリンクではビルドを失敗させます。
+
+```ts
+export default {
+ ignoreDeadLinks: true
+}
+```
+
+正確な URL 文字列、正規表現、カスタムフィルタ関数の配列として指定することもできます。
+
+```ts
+export default {
+ ignoreDeadLinks: [
+ // 正確に "/playground" を無視
+ '/playground',
+ // すべての localhost リンクを無視
+ /^https?:\/\/localhost/,
+ // パスに "/repl/" を含むリンクを無視
+ /\/repl\//,
+ // カスタム関数: "ignore" を含むリンクを無視
+ (url) => {
+ return url.toLowerCase().includes('ignore')
+ }
+ ]
+}
+```
+
+### metaChunk `
+
+`buildEnd` はビルド CLI フックです。ビルド（SSG）が完了した後、VitePress CLI プロセスが終了する前に実行されます。
+
+```ts
+export default {
+ async buildEnd(siteConfig) {
+ // ...
+ }
+}
+```
+
+### postRender
+
+- 型: `(context: SSGContext) => Awaitable`
+
+`postRender` は SSG のレンダリング完了時に呼ばれるビルドフックです。SSG 中の teleport コンテンツの処理に利用できます。
+
+```ts
+export default {
+ async postRender(context) {
+ // ...
+ }
+}
+```
+
+```ts
+interface SSGContext {
+ content: string
+ teleports?: Record
+ [key: string]: any
+}
+```
+
+### transformHead
+
+- 型: `(context: TransformContext) => Awaitable`
+
+`transformHead` は、各ページを生成する前に head を変換するためのビルドフックです。設定ファイルでは静的に追加できない head 要素を追加できます。追加分のみ返せば、既存のものと自動でマージされます。
+
+::: warning
+`context` 内の値は変更しないでください。
+:::
+
+```ts
+export default {
+ async transformHead(context) {
+ // ...
+ }
+}
+```
+
+```ts
+interface TransformContext {
+ page: string // 例: index.md（srcDir からの相対）
+ assets: string[] // 解決済みの公開 URL（非 js/css アセット）
+ siteConfig: SiteConfig
+ siteData: SiteData
+ pageData: PageData
+ title: string
+ description: string
+ head: HeadConfig[]
+ content: string
+}
+```
+
+このフックは静的サイト生成時のみ呼ばれ、開発中には呼ばれません。開発中に動的な head 要素を追加したい場合は、代わりに [`transformPageData`](#transformpagedata) を使用できます。
+
+```ts
+export default {
+ transformPageData(pageData) {
+ pageData.frontmatter.head ??= []
+ pageData.frontmatter.head.push([
+ 'meta',
+ {
+ name: 'og:title',
+ content:
+ pageData.frontmatter.layout === 'home'
+ ? `VitePress`
+ : `${pageData.title} | VitePress`
+ }
+ ])
+ }
+}
+```
+
+#### 例: 正規 URL の `` を追加 {#example-adding-a-canonical-url-link}
+
+```ts
+export default {
+ transformPageData(pageData) {
+ const canonicalUrl = `https://example.com/${pageData.relativePath}`
+ .replace(/index\.md$/, '')
+ .replace(/\.md$/, '.html')
+
+ pageData.frontmatter.head ??= []
+ pageData.frontmatter.head.push([
+ 'link',
+ { rel: 'canonical', href: canonicalUrl }
+ ])
+ }
+}
+```
+
+### transformHtml
+
+- 型: `(code: string, id: string, context: TransformContext) => Awaitable`
+
+`transformHtml` は、各ページの内容をディスクへ保存する前に変換するためのビルドフックです。
+
+::: warning
+`context` 内の値は変更しないでください。また、HTML を変更すると実行時のハイドレーション問題を引き起こす可能性があります。
+:::
+
+```ts
+export default {
+ async transformHtml(code, id, context) {
+ // ...
+ }
+}
+```
+
+### transformPageData
+
+- 型: `(pageData: PageData, context: TransformPageContext) => Awaitable | { [key: string]: any } | void>`
+
+`transformPageData` は各ページの `pageData` を変換するためのフックです。`pageData` を直接変更するか、変更値を返してマージさせることができます。
+
+::: warning
+`context` 内の値は変更しないでください。ネットワークリクエストや重い計算（画像生成など）を行うと開発サーバのパフォーマンスに影響します。`process.env.NODE_ENV === 'production'` を用いた条件分岐を検討してください。
+:::
+
+```ts
+export default {
+ async transformPageData(pageData, { siteConfig }) {
+ pageData.contributors = await getPageContributors(pageData.relativePath)
+ }
+
+ // あるいはマージ用の値を返す
+ async transformPageData(pageData, { siteConfig }) {
+ return {
+ contributors: await getPageContributors(pageData.relativePath)
+ }
+ }
+}
+```
+
+```ts
+interface TransformPageContext {
+ siteConfig: SiteConfig
+}
+```
diff --git a/docs/.vitepress/config/ko.ts b/docs/ko/config.ts
similarity index 69%
rename from docs/.vitepress/config/ko.ts
rename to docs/ko/config.ts
index faebabf4..b2fbecf3 100644
--- a/docs/.vitepress/config/ko.ts
+++ b/docs/ko/config.ts
@@ -1,16 +1,17 @@
import { createRequire } from 'module'
-import { defineConfig, type DefaultTheme } from 'vitepress'
+import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
const require = createRequire(import.meta.url)
const pkg = require('vitepress/package.json')
-export const ko = defineConfig({
- lang: 'ko-KR',
+export default defineAdditionalConfig({
description: 'Vite 및 Vue 기반 정적 사이트 생성기.',
themeConfig: {
nav: nav(),
+ search: { options: searchOptions() },
+
sidebar: {
'/ko/guide/': { base: '/ko/guide/', items: sidebarGuide() },
'/ko/reference/': { base: '/ko/reference/', items: sidebarReference() }
@@ -39,6 +40,14 @@ export const ko = defineConfig({
text: '업데이트 날짜'
},
+ notFound: {
+ title: '페이지를 찾을 수 없습니다',
+ quote:
+ '방향을 바꾸지 않고 계속 찾다 보면 결국 당신이 가고 있는 곳에 도달할 수도 있습니다.',
+ linkLabel: '홈으로 가기',
+ linkText: '집으로 데려가줘'
+ },
+
langMenuLabel: '언어 변경',
returnToTopLabel: '맨 위로 돌아가기',
sidebarMenuLabel: '사이드바 메뉴',
@@ -64,6 +73,10 @@ function nav(): DefaultTheme.NavItem[] {
{
text: pkg.version,
items: [
+ {
+ text: '1.6.4',
+ link: 'https://vuejs.github.io/vitepress/v1/ko/'
+ },
{
text: '변경 로그',
link: 'https://github.com/vuejs/vitepress/blob/main/CHANGELOG.md'
@@ -208,8 +221,8 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
]
}
-export const search: DefaultTheme.AlgoliaSearchOptions['locales'] = {
- ko: {
+function searchOptions(): Partial {
+ return {
placeholder: '문서 검색',
translations: {
button: {
@@ -218,10 +231,16 @@ export const search: DefaultTheme.AlgoliaSearchOptions['locales'] = {
},
modal: {
searchBox: {
- resetButtonTitle: '검색 지우기',
- resetButtonAriaLabel: '검색 지우기',
- cancelButtonText: '취소',
- cancelButtonAriaLabel: '취소'
+ clearButtonTitle: '검색 지우기',
+ clearButtonAriaLabel: '검색 지우기',
+ closeButtonText: '닫기',
+ closeButtonAriaLabel: '닫기',
+ placeholderText: '문서 검색',
+ placeholderTextAskAi: 'AI에게 물어보기: ',
+ placeholderTextAskAiStreaming: '답변 작성 중...',
+ searchInputLabel: '검색',
+ backToKeywordSearchButtonText: '키워드 검색으로 돌아가기',
+ backToKeywordSearchButtonAriaLabel: '키워드 검색으로 돌아가기'
},
startScreen: {
recentSearchesTitle: '검색 기록',
@@ -229,23 +248,50 @@ export const search: DefaultTheme.AlgoliaSearchOptions['locales'] = {
saveRecentSearchButtonTitle: '검색 기록에 저장',
removeRecentSearchButtonTitle: '검색 기록에서 삭제',
favoriteSearchesTitle: '즐겨찾기',
- removeFavoriteSearchButtonTitle: '즐겨찾기에서 삭제'
+ 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: '검색 완료',
+ aggregatedToolCallText: '검색 완료'
+ },
footer: {
selectText: '선택',
+ submitQuestionText: '질문 보내기',
+ selectKeyAriaLabel: 'Enter 키',
navigateText: '탐색',
+ navigateUpKeyAriaLabel: '위쪽 화살표',
+ navigateDownKeyAriaLabel: '아래쪽 화살표',
closeText: '닫기',
- searchByText: '검색 기준'
- },
- noResultsScreen: {
- noResultsText: '결과를 찾을 수 없습니다',
- suggestedQueryText: '새로운 검색을 시도할 수 있습니다',
- reportMissingResultsText: '해당 검색어에 대한 결과가 있어야 합니까?',
- reportMissingResultsLinkText: '피드백 보내기 클릭'
+ backToSearchText: '검색으로 돌아가기',
+ closeKeyAriaLabel: 'Esc 키',
+ poweredByText: '제공: '
}
}
}
diff --git a/docs/ko/guide/deploy.md b/docs/ko/guide/deploy.md
index 797015da..7a57a8ad 100644
--- a/docs/ko/guide/deploy.md
+++ b/docs/ko/guide/deploy.md
@@ -162,7 +162,7 @@ HTML 코드에 대해 _Auto Minify_ 옵션을 활성화하지 마세요. 이는
- name: Setup Node
uses: actions/setup-node@v4
with:
- node-version: 20
+ node-version: 22
cache: npm # 또는 pnpm / yarn
- name: Setup Pages
uses: actions/configure-pages@v4
diff --git a/docs/ko/guide/extending-default-theme.md b/docs/ko/guide/extending-default-theme.md
index 6e64646f..b8b795e6 100644
--- a/docs/ko/guide/extending-default-theme.md
+++ b/docs/ko/guide/extending-default-theme.md
@@ -70,7 +70,7 @@ export default DefaultTheme
export default {
transformHead({ assets }) {
// 폰트를 매칭하기 위해 정규식을 적절히 조정하세요
- const myFontFile = assets.find(file => /font-name\.\w+\.woff2/)
+ const myFontFile = assets.find(file => /font-name\.[\w-]+\.woff2/.test(file))
if (myFontFile) {
return [
[
@@ -252,6 +252,7 @@ provide('toggle-appearance', async ({ clientX: x, clientY: y }: MouseEvent) => {
{
duration: 300,
easing: 'ease-in',
+ fill: 'forwards',
pseudoElement: `::view-transition-${isDark.value ? 'old' : 'new'}(root)`
}
)
diff --git a/docs/ko/guide/getting-started.md b/docs/ko/guide/getting-started.md
index ac7e7ca6..632e9078 100644
--- a/docs/ko/guide/getting-started.md
+++ b/docs/ko/guide/getting-started.md
@@ -19,39 +19,19 @@ VitePress는 단독으로 사용하거나 기존 프로젝트에 설치할 수
::: code-group
```sh [npm]
-$ npm add -D vitepress
+$ npm add -D vitepress@next
```
```sh [pnpm]
-$ pnpm add -D vitepress
+$ pnpm add -D vitepress@next
```
```sh [yarn]
-$ yarn add -D vitepress
-```
-
-```sh [yarn (pnp)]
-$ yarn add -D vitepress vue
+$ yarn add -D vitepress@next vue
```
```sh [bun]
-$ bun add -D vitepress
-```
-
-:::
-
-::: details "missing peer deps" 경고가 표시되나요?
-PNPM을 사용하는 경우 `@docsearch/js`에 대한 "missing peer deps" 경고가 표시됩니다. 이는 VitePress가 작동하는 것을 방해하지 않습니다. 이 경고를 억제하려면 `package.json`에 다음을 추가합니다:
-
-```json
-"pnpm": {
- "peerDependencyRules": {
- "ignoreMissing": [
- "@algolia/client-search",
- "search-insights"
- ]
- }
-}
+$ bun add -D vitepress@next
```
:::
diff --git a/docs/ko/guide/markdown.md b/docs/ko/guide/markdown.md
index 5f03bbf6..f2003ca6 100644
--- a/docs/ko/guide/markdown.md
+++ b/docs/ko/guide/markdown.md
@@ -255,11 +255,11 @@ export default defineConfig({
}
```
- 이것은 기본적으로 [`postcss-prefix-selector`](https://github.com/RadValentin/postcss-prefix-selector)를 사용합니다. 다음과 같이 옵션을 전달할 수 있습니다:
+ 다음과 같이 옵션을 전달할 수 있습니다:
```js
postcssIsolateStyles({
- includeFiles: [/vp-doc\.css/] // 기본값은 /base\.css/
+ includeFiles: [/custom\.css/] // 기본값은 [/vp-doc\.css/, /base\.css/]
})
```
diff --git a/docs/ko/guide/using-vue.md b/docs/ko/guide/using-vue.md
index 5c65eeb7..0146352a 100644
--- a/docs/ko/guide/using-vue.md
+++ b/docs/ko/guide/using-vue.md
@@ -125,7 +125,7 @@ import CustomComponent from '../components/CustomComponent.vue'
컴포넌트가 대부분의 페이지에서 사용될 경우, Vue 앱 인스턴스를 커스텀하여 전역적으로 등록할 수 있습니다. [기본 테마 확장](./extending-default-theme#registering-global-components)의 관련 섹션을 예제를 참고하세요.
::: warning 중요
-커스텀 컴포넌트의 이름에 하이픈이 포함되어 있거나 파스칼케이스(PascalCase)e인지 확인하세요. 그렇지 않으면 인라인 요소로 처리되어 `` 태그 안에 래핑됩니다. `
`는 블록 엘리먼트를 내부에 배치할 수 없기 때문에 하이드레이션 불일치가 발생합니다.
+커스텀 컴포넌트의 이름에 하이픈이 포함되어 있거나 파스칼케이스(PascalCase)인지 확인하세요. 그렇지 않으면 인라인 요소로 처리되어 `
` 태그 안에 래핑됩니다. `
`는 블록 엘리먼트를 내부에 배치할 수 없기 때문에 하이드레이션 불일치가 발생합니다.
:::
### 헤더에 ` | Public 기본 경로 (기본값: `/`) (`string`) |
| `--target ` | 트랜스파일 대상 (기본값: `"modules"`) (`string`) |
| `--outDir ` | **cwd** 기준 출력 디렉터리 (기본값: `/.vitepress/dist`) (`string`) |
-| `--minify [minifier]` | minify 활성화/비활성화 또는 사용할 minify 도구 지정 (기본값: `"esbuild"`) (`boolean \| "terser" \| "esbuild"`) |
| `--assetsInlineLimit `| 바이트 단위의 정적 에셋 base64 인라인 임계값 (기본값: `4096`) (`number`) |
## `vitepress preview`
diff --git a/docs/ko/reference/default-theme-config.md b/docs/ko/reference/default-theme-config.md
index b0df3361..66b2f4e0 100644
--- a/docs/ko/reference/default-theme-config.md
+++ b/docs/ko/reference/default-theme-config.md
@@ -89,7 +89,7 @@ type NavItem = NavItemWithLink | NavItemWithChildren
interface NavItemWithLink {
text: string
- link: string
+ link: string | ((payload: PageData) => string)
activeMatch?: string
target?: string
rel?: string
diff --git a/docs/ko/reference/default-theme-nav.md b/docs/ko/reference/default-theme-nav.md
index cdfdc7ef..433c2e07 100644
--- a/docs/ko/reference/default-theme-nav.md
+++ b/docs/ko/reference/default-theme-nav.md
@@ -55,6 +55,8 @@ export default {
`text`는 네비게이션 바에 표시되는 실제 텍스트이며, `link`는 텍스트를 클릭했을 때 이동할 링크입니다. 링크의 경로는 `.md` 접미사 없이 실제 파일 경로로 설정하며, 항상 `/`로 시작해야 합니다.
+`link`는 또한 [`PageData`](./runtime-api#usedata)를 인자로 받아 경로를 반환하는 함수가 될 수도 있습니다.
+
네비게이션 바 링크는 드롭다운 메뉴가 될 수 있습니다. 이를 위해 `link` 옵션에 `items` 키를 설정합니다.
```js
diff --git a/docs/ko/reference/default-theme-search.md b/docs/ko/reference/default-theme-search.md
index 69b633aa..03eda030 100644
--- a/docs/ko/reference/default-theme-search.md
+++ b/docs/ko/reference/default-theme-search.md
@@ -377,3 +377,20 @@ new Crawler({
}
})
```
+
+### Algolia Ask AI 지원 {#ask-ai}
+
+**Ask AI** 기능을 사용하려면 `askAi` 옵션을 추가하세요:
+
+```ts
+options: {
+ appId: '...',
+ apiKey: '...',
+ indexName: '...',
+ askAi: { assistantId: 'XXXYYY' }
+}
+```
+
+::: warning 참고
+Ask AI를 사용하지 않으려면 `askAi` 옵션을 생략하면 됩니다.
+:::
diff --git a/docs/ko/reference/default-theme-sidebar.md b/docs/ko/reference/default-theme-sidebar.md
index 21e19ccc..8e4709cd 100644
--- a/docs/ko/reference/default-theme-sidebar.md
+++ b/docs/ko/reference/default-theme-sidebar.md
@@ -180,36 +180,3 @@ export default {
}
}
```
-
-## `useSidebar`
- sidebar: ComputedRef
- sidebarGroups: ComputedRef
- hasSidebar: ComputedRef
- hasAside: ComputedRef
- leftAside: ComputedRef
- isSidebarEnabled: ComputedRef
- open: () => void
- close: () => void
- toggle: () => void
-}
-```
-
-**예제:**
-
-```vue
-
-
-
- 사이드바가 있을 때만 보여줍니다
-
-```
diff --git a/docs/ko/reference/default-theme-team-page.md b/docs/ko/reference/default-theme-team-page.md
index 2123f349..b4fddb0f 100644
--- a/docs/ko/reference/default-theme-team-page.md
+++ b/docs/ko/reference/default-theme-team-page.md
@@ -53,12 +53,12 @@ const members = [
Say hello to our awesome team.
-` 컴포넌트는 `small`과 `medium` 두 가지 크기로 제공됩니다. 개인의 선호도에 따라 선택할 수 있지만, 일반적으로 `small` 사이즈가 문서 페이지에 더 적합합니다. 또한, 각 구성원에 "설명"이나 "후원" 버튼과 같은 프로퍼티를 추가할 수도 있습니다. 자세한 내용은 [``](#vpteammembers)에서 확인할 수 있습니다.
@@ -107,9 +107,7 @@ const members = [
team, some of whom have chosen to be featured below.
-
```
diff --git a/docs/ko/reference/site-config.md b/docs/ko/reference/site-config.md
index 949b8452..ad5a717d 100644
--- a/docs/ko/reference/site-config.md
+++ b/docs/ko/reference/site-config.md
@@ -458,7 +458,7 @@ export default {
### ignoreDeadLinks
-- 타입: `boolean | 'localhostLinks' | (string | RegExp | ((link: string) => boolean))[]`
+- 타입: `boolean | 'localhostLinks' | (string | RegExp | ((link: string, source: string) => boolean))[]`
- 기본값: `false`
`true`로 설정하면, 빌드 시 죽은 링크로 인해 실패하지 않습니다.
diff --git a/docs/lunaria.config.json b/docs/lunaria.config.json
index 60abdd98..2de958b9 100644
--- a/docs/lunaria.config.json
+++ b/docs/lunaria.config.json
@@ -6,8 +6,8 @@
},
"files": [
{
- "location": ".vitepress/config/{en,zh,pt,ru,es,ko,fa}.ts",
- "pattern": ".vitepress/config/@lang.ts",
+ "location": "**/config.ts",
+ "pattern": "@lang/@path",
"type": "universal"
},
{
@@ -44,6 +44,10 @@
{
"label": "فارسی",
"lang": "fa"
+ },
+ {
+ "label": "日本語",
+ "lang": "ja"
}
],
"outDir": ".vitepress/dist/_translations",
diff --git a/docs/package.json b/docs/package.json
index d3c19d0c..f0aa0873 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -13,8 +13,9 @@
"@lunariajs/core": "^0.1.1",
"markdown-it-mathjax3": "^4.3.2",
"open-cli": "^8.0.0",
- "postcss-rtlcss": "^5.6.0",
+ "postcss-rtlcss": "^5.7.1",
"vitepress": "workspace:*",
- "vitepress-plugin-group-icons": "^1.3.6"
+ "vitepress-plugin-group-icons": "^1.6.3",
+ "vitepress-plugin-llms": "^1.7.3"
}
}
diff --git a/docs/.vitepress/config/pt.ts b/docs/pt/config.ts
similarity index 67%
rename from docs/.vitepress/config/pt.ts
rename to docs/pt/config.ts
index 12cb52fa..ae71473d 100644
--- a/docs/.vitepress/config/pt.ts
+++ b/docs/pt/config.ts
@@ -1,16 +1,17 @@
import { createRequire } from 'module'
-import { defineConfig, type DefaultTheme } from 'vitepress'
+import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
const require = createRequire(import.meta.url)
const pkg = require('vitepress/package.json')
-export const pt = defineConfig({
- lang: 'pt-BR',
+export default defineAdditionalConfig({
description: 'Gerador de Site Estático desenvolvido com Vite e Vue.',
themeConfig: {
nav: nav(),
+ search: { options: searchOptions() },
+
sidebar: {
'/pt/guide/': { base: '/pt/guide/', items: sidebarGuide() },
'/pt/reference/': { base: '/pt/reference/', items: sidebarReference() }
@@ -36,11 +37,15 @@ export const pt = defineConfig({
},
lastUpdated: {
- text: 'Atualizado em',
- formatOptions: {
- dateStyle: 'short',
- timeStyle: 'medium'
- }
+ text: 'Atualizado em'
+ },
+
+ notFound: {
+ title: 'PÁGINA NÃO ENCONTRADA',
+ quote:
+ 'Mas se você não mudar de direção e continuar procurando, pode acabar onde está indo.',
+ linkLabel: 'ir para a página inicial',
+ linkText: 'Me leve para casa'
},
langMenuLabel: 'Alterar Idioma',
@@ -68,6 +73,10 @@ function nav(): DefaultTheme.NavItem[] {
{
text: pkg.version,
items: [
+ {
+ text: '1.6.4',
+ link: 'https://vuejs.github.io/vitepress/v1/pt/'
+ },
{
text: 'Registro de Mudanças',
link: 'https://github.com/vuejs/vitepress/blob/main/CHANGELOG.md'
@@ -167,8 +176,8 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
]
}
-export const search: DefaultTheme.AlgoliaSearchOptions['locales'] = {
- pt: {
+function searchOptions(): Partial {
+ return {
placeholder: 'Pesquisar documentos',
translations: {
button: {
@@ -177,35 +186,69 @@ export const search: DefaultTheme.AlgoliaSearchOptions['locales'] = {
},
modal: {
searchBox: {
- resetButtonTitle: 'Limpar pesquisa',
- resetButtonAriaLabel: 'Limpar pesquisa',
- cancelButtonText: 'Cancelar',
- cancelButtonAriaLabel: 'Cancelar'
+ clearButtonTitle: 'Limpar pesquisa',
+ clearButtonAriaLabel: 'Limpar pesquisa',
+ closeButtonText: 'Fechar',
+ closeButtonAriaLabel: 'Fechar',
+ placeholderText: 'Pesquisar documentos',
+ placeholderTextAskAi: 'Pergunte à IA: ',
+ placeholderTextAskAiStreaming: 'Respondendo...',
+ searchInputLabel: 'Pesquisar',
+ backToKeywordSearchButtonText: 'Voltar à pesquisa por palavras-chave',
+ backToKeywordSearchButtonAriaLabel:
+ 'Voltar à pesquisa por palavras-chave'
},
startScreen: {
- recentSearchesTitle: 'Histórico de Pesquisa',
+ recentSearchesTitle: 'Histórico de pesquisa',
noRecentSearchesText: 'Nenhuma pesquisa recente',
saveRecentSearchButtonTitle: 'Salvar no histórico de pesquisas',
removeRecentSearchButtonTitle: 'Remover do histórico de pesquisas',
favoriteSearchesTitle: 'Favoritos',
- removeFavoriteSearchButtonTitle: 'Remover dos favoritos'
+ removeFavoriteSearchButtonTitle: 'Remover dos favoritos',
+ recentConversationsTitle: 'Conversas recentes',
+ removeRecentConversationButtonTitle:
+ 'Remover esta conversa do histórico'
},
errorScreen: {
titleText: 'Não foi possível obter resultados',
- helpText: 'Verifique a sua conexão de rede'
+ helpText: 'Verifique sua conexão de rede'
+ },
+ noResultsScreen: {
+ noResultsText: 'Nenhum resultado encontrado',
+ suggestedQueryText: 'Você pode tentar uma nova consulta',
+ reportMissingResultsText: 'Acha que deveria haver resultados?',
+ reportMissingResultsLinkText: 'Clique para enviar feedback'
+ },
+ resultsScreen: {
+ askAiPlaceholder: 'Pergunte à IA: '
+ },
+ askAiScreen: {
+ disclaimerText:
+ 'As respostas são geradas por IA e podem conter erros. Verifique as respostas.',
+ relatedSourcesText: 'Fontes relacionadas',
+ thinkingText: 'Pensando...',
+ copyButtonText: 'Copiar',
+ copyButtonCopiedText: 'Copiado!',
+ copyButtonTitle: 'Copiar',
+ likeButtonTitle: 'Curtir',
+ dislikeButtonTitle: 'Não curtir',
+ thanksForFeedbackText: 'Obrigado pelo feedback!',
+ preToolCallText: 'Pesquisando...',
+ duringToolCallText: 'Pesquisando ',
+ afterToolCallText: 'Pesquisa concluída',
+ aggregatedToolCallText: 'Pesquisa concluída'
},
footer: {
selectText: 'Selecionar',
+ submitQuestionText: 'Enviar pergunta',
+ selectKeyAriaLabel: 'Tecla Enter',
navigateText: 'Navegar',
+ navigateUpKeyAriaLabel: 'Seta para cima',
+ navigateDownKeyAriaLabel: 'Seta para baixo',
closeText: 'Fechar',
- searchByText: 'Pesquisa por'
- },
- noResultsScreen: {
- noResultsText: 'Não foi possível encontrar resultados',
- suggestedQueryText: 'Você pode tentar uma nova consulta',
- reportMissingResultsText:
- 'Deveriam haver resultados para essa consulta?',
- reportMissingResultsLinkText: 'Clique para enviar feedback'
+ backToSearchText: 'Voltar à pesquisa',
+ closeKeyAriaLabel: 'Tecla Escape',
+ poweredByText: 'Pesquisa por'
}
}
}
diff --git a/docs/pt/guide/deploy.md b/docs/pt/guide/deploy.md
index 9a03631b..b112bf7d 100644
--- a/docs/pt/guide/deploy.md
+++ b/docs/pt/guide/deploy.md
@@ -163,7 +163,7 @@ Não ative opções como _Auto Minify_ para código HTML. Isso removerá coment
- name: Setup Node
uses: actions/setup-node@v4
with:
- node-version: 20
+ node-version: 22
cache: npm # ou pnpm / yarn
- name: Setup Pages
uses: actions/configure-pages@v4
diff --git a/docs/pt/guide/extending-default-theme.md b/docs/pt/guide/extending-default-theme.md
index 08aea50a..f3175f83 100644
--- a/docs/pt/guide/extending-default-theme.md
+++ b/docs/pt/guide/extending-default-theme.md
@@ -70,7 +70,7 @@ Se a sua fonte é um arquivo local referenciado via `@font-face`, ela será proc
export default {
transformHead({ assets }) {
// ajuste o regex para corresponder à sua fonte
- const myFontFile = assets.find(file => /font-name\.\w+\.woff2/)
+ const myFontFile = assets.find(file => /font-name\.[\w-]+\.woff2/.test(file))
if (myFontFile) {
return [
[
@@ -251,6 +251,7 @@ provide('toggle-appearance', async ({ clientX: x, clientY: y }: MouseEvent) => {
{
duration: 300,
easing: 'ease-in',
+ fill: 'forwards',
pseudoElement: `::view-transition-${isDark.value ? 'old' : 'new'}(root)`
}
)
diff --git a/docs/pt/guide/getting-started.md b/docs/pt/guide/getting-started.md
index e6668cb2..c0dba3a9 100644
--- a/docs/pt/guide/getting-started.md
+++ b/docs/pt/guide/getting-started.md
@@ -18,39 +18,19 @@ VitePress pode ser usado sozinho, ou ser instalado em um projeto já existente.
::: code-group
```sh [npm]
-$ npm add -D vitepress
+$ npm add -D vitepress@next
```
```sh [pnpm]
-$ pnpm add -D vitepress
+$ pnpm add -D vitepress@next
```
```sh [yarn]
-$ yarn add -D vitepress
-```
-
-```sh [yarn (pnp)]
-$ yarn add -D vitepress vue
+$ yarn add -D vitepress@next vue
```
```sh [bun]
-$ bun add -D vitepress
-```
-
-:::
-
-::: details Está recebendo avisos sobre dependências correspondentes ausentes?
-Se usar PNPM, você perceberá um aviso de ausência de `@docsearch/js`. Isso não evita que o VitePress funcione. Se você deseja suprimir este aviso, adicione o seguinte no seu `package.json`:
-
-```json
-"pnpm": {
- "peerDependencyRules": {
- "ignoreMissing": [
- "@algolia/client-search",
- "search-insights"
- ]
- }
-}
+$ bun add -D vitepress@next
```
:::
diff --git a/docs/pt/guide/markdown.md b/docs/pt/guide/markdown.md
index b5245259..c4186270 100644
--- a/docs/pt/guide/markdown.md
+++ b/docs/pt/guide/markdown.md
@@ -255,11 +255,11 @@ A classe `vp-raw` também pode ser usada diretamente em elementos. O isolamento
}
```
- Ele utiliza [`postcss-prefix-selector`](https://github.com/postcss/postcss-load-config) internamente. Você pode passar opções assim:
+ Você pode passar opções assim:
```js
postcssIsolateStyles({
- includeFiles: [/vp-doc\.css/] // o padrão é /base\.css/
+ includeFiles: [/custom\.css/] // o padrão é [/vp-doc\.css/, /base\.css/]
})
```
diff --git a/docs/pt/guide/using-vue.md b/docs/pt/guide/using-vue.md
index 226d90d2..a034108d 100644
--- a/docs/pt/guide/using-vue.md
+++ b/docs/pt/guide/using-vue.md
@@ -128,7 +128,7 @@ Se um componente for usado na maioria das páginas, eles podem ser registrados g
Certifique-se de que o nome de um componente personalizado contenha um hífen ou esteja em PascalCase. Caso contrário, ele será tratado como um elemento alinhado e envolvido dentro de uma tag ``, o que levará a uma incompatibilidade de hidratação pois `
` não permite que elementos de bloco sejam colocados dentro dele.
:::
-### Usando Componentes Em Cabeçalhos ` | Caminho base público (padrão: `/`) (`string`) |
| `--target ` | Transpila o alvo (padrão: `"modules"`) (`string`) |
| `--outDir ` | Diretório de saída relativo ao **cwd** (padrão: `/.vitepress/dist`) (`string`) |
-| `--minify [minifier]` | Habilita/desabilita minificação, ou especifica um minificador para usar (padrão: `"esbuild"`) (`boolean \| "terser" \| "esbuild"`) |
| `--assetsInlineLimit ` | Limite em bytes para alinhar ativos em base64 (padrão: `4096`) (`number`) |
## `vitepress preview`
diff --git a/docs/pt/reference/default-theme-config.md b/docs/pt/reference/default-theme-config.md
index 54e53e4a..a1ac180f 100644
--- a/docs/pt/reference/default-theme-config.md
+++ b/docs/pt/reference/default-theme-config.md
@@ -89,7 +89,7 @@ type NavItem = NavItemWithLink | NavItemWithChildren
interface NavItemWithLink {
text: string
- link: string
+ link: string | ((payload: PageData) => string)
activeMatch?: string
target?: string
rel?: string
diff --git a/docs/pt/reference/default-theme-nav.md b/docs/pt/reference/default-theme-nav.md
index 5f0d2399..fefc9661 100644
--- a/docs/pt/reference/default-theme-nav.md
+++ b/docs/pt/reference/default-theme-nav.md
@@ -55,6 +55,8 @@ export default {
`text` é o próprio texto mostrado na navegação, e o `link` é o link para o qual será navegado quando o texto for clicado. Para o link, defina o caminho para o próprio arquivo sem o prefixo `.md` e sempre comece com `/`.
+O `link` também pode ser uma função que aceita [`PageData`](./runtime-api#usedata) como argumento e retorna o caminho.
+
Links de navegação também podem ser menus _dropdown_. Para fazer isso, defina a chave `items` na opção do link.
```js
diff --git a/docs/pt/reference/default-theme-search.md b/docs/pt/reference/default-theme-search.md
index c16406cb..4db22900 100644
--- a/docs/pt/reference/default-theme-search.md
+++ b/docs/pt/reference/default-theme-search.md
@@ -370,3 +370,20 @@ new Crawler({
}
})
```
+
+### Suporte ao Algolia Ask AI {#ask-ai}
+
+Se quiser incluir o **Ask AI**, adicione `askAi` em `options`:
+
+```ts
+options: {
+ appId: '...',
+ apiKey: '...',
+ indexName: '...',
+ askAi: { assistantId: 'XXXYYY' }
+}
+```
+
+::: warning Nota
+Caso queira apenas a pesquisa por palavra-chave, omita `askAi`.
+:::
diff --git a/docs/pt/reference/default-theme-sidebar.md b/docs/pt/reference/default-theme-sidebar.md
index 62c3b3b1..0d8baf8d 100644
--- a/docs/pt/reference/default-theme-sidebar.md
+++ b/docs/pt/reference/default-theme-sidebar.md
@@ -180,36 +180,3 @@ export default {
}
}
```
-
-## `useSidebar`
- sidebar: ComputedRef
- sidebarGroups: ComputedRef
- hasSidebar: ComputedRef
- hasAside: ComputedRef
- leftAside: ComputedRef
- isSidebarEnabled: ComputedRef
- open: () => void
- close: () => void
- toggle: () => void
-}
-```
-
-**Exemplo:**
-
-```vue
-
-
-
- Visível apenas quando a barra lateral existe
-
-```
diff --git a/docs/pt/reference/default-theme-team-page.md b/docs/pt/reference/default-theme-team-page.md
index 1daa47a5..32a9db0d 100644
--- a/docs/pt/reference/default-theme-team-page.md
+++ b/docs/pt/reference/default-theme-team-page.md
@@ -53,12 +53,12 @@ const members = [
Diga olá à nossa equipe incrível.
-` vem em 2 tamanhos diferentes, pequeno `small` e médio `medium`. Enquanto é uma questão de preferência, geralmente o tamanho `small` deve encaixar melhor quando usado na página de documento. Além disso, você pode adicionar mais propriedades a cada membro, como adicionar o botão "descrição" ou "patrocinador". Saiba mais sobre em [``](#vpteammembers).
@@ -107,9 +107,7 @@ const members = [
alguns dos membros escolheram ser apresentados abaixo.
-
```
diff --git a/docs/pt/reference/site-config.md b/docs/pt/reference/site-config.md
index 84b8493a..6f344017 100644
--- a/docs/pt/reference/site-config.md
+++ b/docs/pt/reference/site-config.md
@@ -24,7 +24,7 @@ export default {
}
```
-:::details Configuração Dinâmica (Assíncrona)
+::: details Configuração Dinâmica (Assíncrona)
Se você precisar gerar dinamicamente a configuração, também pode exportar por padrão uma função. Por exemplo:
@@ -458,7 +458,7 @@ export default {
### ignoreDeadLinks
-- Tipo: `boolean | 'localhostLinks' | (string | RegExp | ((link: string) => boolean))[]`
+- Tipo: `boolean | 'localhostLinks' | (string | RegExp | ((link: string, source: string) => boolean))[]`
- Padrão: `false`
Quando definido como `true`, VitePress não falhará na compilação devido a links quebrados.
@@ -613,7 +613,7 @@ export default {
`transformHead` é um gancho de compilação para transformar o cabeçalho antes de gerar cada página. Isso permite adicionar entradas no cabeçalho que não podem ser adicionadas estaticamente à configuração VitePress. Você só precisa retornar entradas extras, que serão mescladas automaticamente com as existentes.
-:::warning
+::: warning
Não faça mutações em qualquer item dentro de `context`.
:::
@@ -681,7 +681,7 @@ export default {
- Tipo: `(code: string, id: string, context: TransformContext) => Awaitable`
`transformHtml` é um gancho de compilação para transformar o conteúdo de cada página antes de salvá-lo no disco.
-:::warning
+::: warning
Não faça mutações em qualquer item dentro de `context`. Além disso, modificar o conteúdo HTML pode causar problemas de hidratação em tempo de execução.
:::
@@ -698,7 +698,7 @@ export default {
`transformPageData` é um gancho para transformar os dados de cada página. Você pode fazer mutações diretamente em `pageData` ou retornar valores alterados que serão mesclados nos dados da página.
-:::warning
+::: warning
Não faça mutações em qualquer item dentro de `context` e tenha cuidado pois isso pode impactar no desempenho do servidor de desenvolvimento, especialmente se você tiver algumas solicitações de rede ou computações pesadas (como gerar imagens) no gancho. Você pode verificar `process.env.NODE_ENV === 'production'` para lógica condicional.
:::
diff --git a/docs/.vitepress/config/ru.ts b/docs/ru/config.ts
similarity index 65%
rename from docs/.vitepress/config/ru.ts
rename to docs/ru/config.ts
index b75b1b77..e196d193 100644
--- a/docs/.vitepress/config/ru.ts
+++ b/docs/ru/config.ts
@@ -1,16 +1,17 @@
import { createRequire } from 'module'
-import { defineConfig, type DefaultTheme } from 'vitepress'
+import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
const require = createRequire(import.meta.url)
const pkg = require('vitepress/package.json')
-export const ru = defineConfig({
- lang: 'ru-RU',
+export default defineAdditionalConfig({
description: 'Генератор статических сайтов на основе Vite и Vue.',
themeConfig: {
nav: nav(),
+ search: { options: searchOptions() },
+
sidebar: {
'/ru/guide/': { base: '/ru/guide/', items: sidebarGuide() },
'/ru/reference/': { base: '/ru/reference/', items: sidebarReference() }
@@ -37,6 +38,14 @@ export const ru = defineConfig({
text: 'Обновлено'
},
+ notFound: {
+ title: 'СТРАНИЦА НЕ НАЙДЕНА',
+ quote:
+ 'Но если ты не изменишь направление и продолжишь искать, ты можешь оказаться там, куда направляешься.',
+ linkLabel: 'перейти на главную',
+ linkText: 'Отведи меня домой'
+ },
+
darkModeSwitchLabel: 'Оформление',
lightModeSwitchTitle: 'Переключить на светлую тему',
darkModeSwitchTitle: 'Переключить на тёмную тему',
@@ -62,6 +71,10 @@ function nav(): DefaultTheme.NavItem[] {
{
text: pkg.version,
items: [
+ {
+ text: '1.6.4',
+ link: 'https://vuejs.github.io/vitepress/v1/ru/'
+ },
{
text: 'Изменения',
link: 'https://github.com/vuejs/vitepress/blob/main/CHANGELOG.md'
@@ -163,8 +176,8 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
]
}
-export const search: DefaultTheme.AlgoliaSearchOptions['locales'] = {
- ru: {
+function searchOptions(): Partial {
+ return {
placeholder: 'Поиск в документации',
translations: {
button: {
@@ -173,10 +186,18 @@ export const search: DefaultTheme.AlgoliaSearchOptions['locales'] = {
},
modal: {
searchBox: {
- resetButtonTitle: 'Сбросить поиск',
- resetButtonAriaLabel: 'Сбросить поиск',
- cancelButtonText: 'Отменить поиск',
- cancelButtonAriaLabel: 'Отменить поиск'
+ clearButtonTitle: 'Очистить поиск',
+ clearButtonAriaLabel: 'Очистить поиск',
+ closeButtonText: 'Закрыть',
+ closeButtonAriaLabel: 'Закрыть',
+ placeholderText: 'Поиск в документации',
+ placeholderTextAskAi: 'Задайте вопрос ИИ: ',
+ placeholderTextAskAiStreaming: 'Формируется ответ...',
+ searchInputLabel: 'Поиск',
+ backToKeywordSearchButtonText:
+ 'Вернуться к поиску по ключевым словам',
+ backToKeywordSearchButtonAriaLabel:
+ 'Вернуться к поиску по ключевым словам'
},
startScreen: {
recentSearchesTitle: 'История поиска',
@@ -184,24 +205,50 @@ export const search: DefaultTheme.AlgoliaSearchOptions['locales'] = {
saveRecentSearchButtonTitle: 'Сохранить в истории поиска',
removeRecentSearchButtonTitle: 'Удалить из истории поиска',
favoriteSearchesTitle: 'Избранное',
- removeFavoriteSearchButtonTitle: 'Удалить из избранного'
+ removeFavoriteSearchButtonTitle: 'Удалить из избранного',
+ recentConversationsTitle: 'Недавние диалоги',
+ removeRecentConversationButtonTitle: 'Удалить этот диалог из истории'
},
errorScreen: {
titleText: 'Невозможно получить результаты',
- helpText: 'Вам может потребоваться проверить подключение к Интернету'
+ helpText: 'Проверьте подключение к Интернету'
+ },
+ noResultsScreen: {
+ noResultsText: 'Ничего не найдено',
+ suggestedQueryText: 'Попробуйте изменить запрос',
+ reportMissingResultsText: 'Считаете, что результаты должны быть?',
+ reportMissingResultsLinkText: 'Сообщите об этом'
+ },
+ resultsScreen: {
+ askAiPlaceholder: 'Задайте вопрос ИИ: '
+ },
+ askAiScreen: {
+ disclaimerText:
+ 'Ответы генерируются ИИ и могут содержать ошибки. Проверяйте информацию.',
+ relatedSourcesText: 'Связанные источники',
+ thinkingText: 'Думаю...',
+ copyButtonText: 'Копировать',
+ copyButtonCopiedText: 'Скопировано!',
+ copyButtonTitle: 'Копировать',
+ likeButtonTitle: 'Нравится',
+ dislikeButtonTitle: 'Не нравится',
+ thanksForFeedbackText: 'Спасибо за отзыв!',
+ preToolCallText: 'Поиск...',
+ duringToolCallText: 'Поиск ',
+ afterToolCallText: 'Поиск завершён',
+ aggregatedToolCallText: 'Поиск завершён'
},
footer: {
selectText: 'выбрать',
+ submitQuestionText: 'Отправить вопрос',
+ selectKeyAriaLabel: 'Клавиша Enter',
navigateText: 'перейти',
+ navigateUpKeyAriaLabel: 'Стрелка вверх',
+ navigateDownKeyAriaLabel: 'Стрелка вниз',
closeText: 'закрыть',
- searchByText: 'поставщик поиска'
- },
- noResultsScreen: {
- noResultsText: 'Нет результатов для',
- suggestedQueryText: 'Вы можете попытаться узнать',
- reportMissingResultsText:
- 'Считаете, что поиск даёт ложные результаты？',
- reportMissingResultsLinkText: 'Нажмите на кнопку «Обратная связь»'
+ backToSearchText: 'Вернуться к поиску',
+ closeKeyAriaLabel: 'Клавиша Esc',
+ poweredByText: 'поиск от'
}
}
}
diff --git a/docs/ru/guide/deploy.md b/docs/ru/guide/deploy.md
index 0de4fbe0..ff12be6c 100644
--- a/docs/ru/guide/deploy.md
+++ b/docs/ru/guide/deploy.md
@@ -111,7 +111,7 @@ Cache-Control: max-age=31536000,immutable
- **Build Command:** `npm run docs:build`
- **Output Directory:** `docs/.vitepress/dist`
-- **Node Version:** `18` (или выше)
+- **Node Version:** `20` (или выше)
::: warning ПРЕДУПРЕЖДЕНИЕ
Не включайте такие опции, как _Auto Minify_ для HTML-кода. Он удалит из вывода комментарии, которые имеют значение для Vue. При их удалении могут возникать ошибки несоответствия гидратации.
@@ -163,7 +163,7 @@ Cache-Control: max-age=31536000,immutable
- name: Setup Node
uses: actions/setup-node@v4
with:
- node-version: 20
+ node-version: 22
cache: npm # или pnpm / yarn
- name: Setup Pages
uses: actions/configure-pages@v4
diff --git a/docs/ru/guide/extending-default-theme.md b/docs/ru/guide/extending-default-theme.md
index a8f0acc7..b1497ced 100644
--- a/docs/ru/guide/extending-default-theme.md
+++ b/docs/ru/guide/extending-default-theme.md
@@ -70,7 +70,7 @@ export default DefaultTheme
export default {
transformHead({ assets }) {
// настраиваем regex соответствующим образом, чтобы он соответствовал вашему шрифту
- const myFontFile = assets.find((file) => /font-name\.\w+\.woff2/)
+ const myFontFile = assets.find(file => /font-name\.[\w-]+\.woff2/.test(file))
if (myFontFile) {
return [
[
@@ -253,6 +253,7 @@ provide('toggle-appearance', async ({ clientX: x, clientY: y }: MouseEvent) => {
{
duration: 300,
easing: 'ease-in',
+ fill: 'forwards',
pseudoElement: `::view-transition-${isDark.value ? 'old' : 'new'}(root)`
}
)
diff --git a/docs/ru/guide/getting-started.md b/docs/ru/guide/getting-started.md
index 21e8dcb0..4ca5ff8c 100644
--- a/docs/ru/guide/getting-started.md
+++ b/docs/ru/guide/getting-started.md
@@ -18,39 +18,19 @@ VitePress можно использовать самостоятельно ил
::: code-group
```sh [npm]
-$ npm add -D vitepress
+$ npm add -D vitepress@next
```
```sh [pnpm]
-$ pnpm add -D vitepress
+$ pnpm add -D vitepress@next
```
```sh [yarn]
-$ yarn add -D vitepress
-```
-
-```sh [yarn (pnp)]
-$ yarn add -D vitepress vue
+$ yarn add -D vitepress@next vue
```
```sh [bun]
-$ bun add -D vitepress
-```
-
-:::
-
-::: details Получаете предупреждения об отсутствующих зависимостях?
-Если вы используете PNPM, вы заметите предупреждение об отсутствующем пакете `@docsearch/js`. Это не мешает работе VitePress. Если вы хотите подавить это предупреждение, добавьте следующее в ваш `package.json`:
-
-```json
-"pnpm": {
- "peerDependencyRules": {
- "ignoreMissing": [
- "@algolia/client-search",
- "search-insights"
- ]
- }
-}
+$ bun add -D vitepress@next
```
:::
diff --git a/docs/ru/guide/markdown.md b/docs/ru/guide/markdown.md
index b67e1355..2bd1a5c1 100644
--- a/docs/ru/guide/markdown.md
+++ b/docs/ru/guide/markdown.md
@@ -281,11 +281,11 @@ console.log('Привет, VitePress!')
}
```
- Он использует [`postcss-prefix-selector`](https://github.com/postcss/postcss-load-config) под капотом. Вы можете передать ему параметры следующим образом:
+ Вы можете передать ему параметры следующим образом:
```js
postcssIsolateStyles({
- includeFiles: [/vp-doc\.css/] // по умолчанию /base\.css/
+ includeFiles: [/custom\.css/] // по умолчанию [/vp-doc\.css/, /base\.css/]
})
```
@@ -783,7 +783,7 @@ export default config
Вы можете включить файл Markdown в другой файл Markdown, даже вложенный.
::: tip СОВЕТ
-Вы также можете добавить в префикс пути к Markdown символ `@`, он будет выступать в качестве корня источника. По умолчанию это корень проекта VitePress, если не настроена опция `srcDir`.
+Вы также можете добавить префикс `@` к пути Markdown, и он будет считаться корневой папкой исходников. По умолчанию корневая папка исходников совпадает с корнем проекта VitePress, если не настроен параметр `srcDir`.
:::
Например, вы можете включить относительный файл Markdown следующим образом:
diff --git a/docs/ru/guide/what-is-vitepress.md b/docs/ru/guide/what-is-vitepress.md
index 1bcc3e18..715ecc89 100644
--- a/docs/ru/guide/what-is-vitepress.md
+++ b/docs/ru/guide/what-is-vitepress.md
@@ -1,6 +1,6 @@
# Что такое VitePress? {#what-is-vitepress}
-VitePress — это [Генератор статических сайтов](https://en.wikipedia.org/wiki/Static_site_generator) (ГСС), предназначенный для быстрого создания сайтов, ориентированных на контент. В двух словах, VitePress берёт ваш исходный контент, написанный в [Markdown](https://ru.wikipedia.org/wiki/Markdown), применяет к нему тему и генерирует статические HTML-страницы, которые можно легко развернуть в любом месте.
+VitePress — это [Генератор статических сайтов](https://en.wikipedia.org/wiki/Static_site_generator) (ГСС), предназначенный для быстрого создания сайтов, ориентированных на контент. В двух словах, VitePress берёт ваш исходный контент, написанный на [Markdown](https://ru.wikipedia.org/wiki/Markdown), применяет к нему тему и генерирует статические HTML-страницы, которые можно легко развернуть в любом месте.
@@ -12,7 +12,7 @@ VitePress — это [Генератор статических сайтов](ht
- **Документация**
- VitePress поставляется с темой по умолчанию, предназначенной для технической документации. Она содержит эту страницу, которую вы сейчас читаете, а также документацию по [Vite](https://vitejs.dev/), [Rollup](https://rollupjs.org/), [Pinia](https://pinia.vuejs.org/), [VueUse](https://vueuse.org/), [Vitest](https://vitest.dev/), [D3](https://d3js.org/), [UnoCSS](https://unocss.dev/), [Iconify](https://iconify.design/) и [многое другое](https://www.vuetelescope.com/explore?framework.slug=vitepress).
+ VitePress поставляется с темой по умолчанию, предназначенной для технической документации. Она содержит эту страницу, которую вы сейчас читаете, а также документацию по [Vite](https://vitejs.dev/), [Rollup](https://rollupjs.org/), [Pinia](https://pinia.vuejs.org/), [VueUse](https://vueuse.org/), [Vitest](https://vitest.dev/), [D3](https://d3js.org/), [UnoCSS](https://unocss.dev/), [Iconify](https://iconify.design/) и [многое другое](https://github.com/search?q=/"vitepress":+/+language:json&type=code).
[Официальная документация Vue.js](https://vuejs.org/) также основана на VitePress, но использует пользовательскую тему, разделяемую между несколькими переводами.
@@ -50,8 +50,8 @@ VitePress стремится обеспечить отличные возмож
## Что насчёт VuePress? {#what-about-vuepress}
-VitePress — это духовный наследник VuePress. Оригинальный VuePress был основан на Vue 2 и webpack. Благодаря Vue 3 и Vite под капотом, VitePress обеспечивает значительно лучший опыт разработки, лучшую производительность, более отточенную тему по умолчанию и более гибкий API для настройки.
+VitePress — это духовный преемник VuePress 1. Оригинальный VuePress 1 был основан на Vue 2 и webpack. С Vue 3 и Vite под капотом VitePress обеспечивает значительно лучший опыт разработки (DX), лучшую производительность в продакшене, более отточенную стандартную тему и более гибкий API для кастомизации.
-Разница в API между VitePress и VuePress заключается в основном в тематическом оформлении и настройке. Если вы используете VuePress 1 с темой по умолчанию, то переход на VitePress будет относительно простым.
+Различия в API между VitePress и VuePress 1 в основном касаются тем и кастомизации. Если вы используете VuePress 1 со стандартной темой, миграция на VitePress должна быть относительно простой.
-Также были приложены усилия для создания VuePress 2, который также поддерживает Vue 3 и Vite с большей совместимостью с VuePress 1. Однако поддерживать два генератора параллельно не представляется возможным, поэтому команда Vue решила сосредоточиться на VitePress как основном рекомендуемом генераторе статических сайтов в долгосрочной перспективе.
+Поддержка двух генераторов статических сайтов (SSG) параллельно не является устойчивой, поэтому команда Vue решила сосредоточиться на VitePress как на основном рекомендуемом SSG в долгосрочной перспективе. Теперь VuePress 1 признан устаревшим, а VuePress 2 передан команде сообщества VuePress для дальнейшей разработки и поддержки.
diff --git a/docs/ru/index.md b/docs/ru/index.md
index 77f2072a..faa45e78 100644
--- a/docs/ru/index.md
+++ b/docs/ru/index.md
@@ -1,9 +1,6 @@
---
layout: home
-title: VitePress
-titleTemplate: Генератор статических сайтов на основе Vite и Vue
-
hero:
name: VitePress
text: Генератор статических сайтов на основе Vite и Vue
@@ -11,10 +8,10 @@ hero:
actions:
- theme: brand
text: Что такое VitePress?
- link: /ru/guide/what-is-vitepress
+ link: ./guide/what-is-vitepress
- theme: alt
text: Первые шаги
- link: /ru/guide/getting-started
+ link: ./guide/getting-started
- theme: alt
text: GitHub
link: https://github.com/vuejs/vitepress
diff --git a/docs/ru/reference/cli.md b/docs/ru/reference/cli.md
index 93954da2..5884a7e8 100644
--- a/docs/ru/reference/cli.md
+++ b/docs/ru/reference/cli.md
@@ -43,7 +43,6 @@ vitepress build [root]
| `--base ` | Публичный базовый путь (по умолчанию: `/`) (`string`) |
| `--target ` | Транспилировать цель (по умолчанию: `"modules"`) (`string`) |
| `--outDir ` | Выходной каталог относительно **cwd** (по умолчанию: `/.vitepress/dist`) (`string`) |
-| `--minify [minifier]` | Включить/выключить минификацию или задать используемый минификатор (по умолчанию: `"esbuild"`) (`boolean \| "terser" \| "esbuild"`) |
| `--assetsInlineLimit ` | Статический встроенный порог ресурса base64 в байтах (по умолчанию: `4096`) (`number`) |
## `vitepress preview` {#vitepress-preview}
diff --git a/docs/ru/reference/default-theme-config.md b/docs/ru/reference/default-theme-config.md
index 348791c0..27b70443 100644
--- a/docs/ru/reference/default-theme-config.md
+++ b/docs/ru/reference/default-theme-config.md
@@ -19,13 +19,13 @@ export default {
**Параметры, описанные на этой странице, применимы только к теме по умолчанию.** Разные темы предполагают разные конфигурации темы. При использовании пользовательской темы объект конфигурации темы будет передан теме, чтобы она могла определить условное поведение на его основе.
-## i18nRouting {#i18nrouting}
+## i18nRouting
- Тип: `boolean`
При смене локали на `ru` URL изменится с `/foo` (или `/en/foo/`) на `/ru/foo`. Вы можете отключить это поведение, установив для параметра `themeConfig.i18nRouting` значение `false`.
-## logo {#logo}
+## logo
- Тип: `ThemeableImage`
@@ -46,7 +46,7 @@ type ThemeableImage =
| { light: string; dark: string; alt?: string }
```
-## siteTitle {#sitetitle}
+## siteTitle
- Тип: `string | false`
@@ -60,7 +60,7 @@ export default {
}
```
-## nav {#nav}
+## nav
- Тип: `NavItem`
@@ -89,7 +89,7 @@ type NavItem = NavItemWithLink | NavItemWithChildren
interface NavItemWithLink {
text: string
- link: string
+ link: string | ((payload: PageData) => string)
activeMatch?: string
target?: string
rel?: string
@@ -108,7 +108,7 @@ interface NavItemWithChildren {
}
```
-## sidebar {#sidebar}
+## sidebar
- Тип: `Sidebar`
@@ -135,7 +135,7 @@ export default {
export type Sidebar = SidebarItem[] | SidebarMulti
export interface SidebarMulti {
- [path: string]: SidebarItem[]
+ [path: string]: SidebarItem[] | { items: SidebarItem[]; base: string }
}
export type SidebarItem = {
@@ -162,10 +162,23 @@ export type SidebarItem = {
* Если `false`, группа сворачивается, но по умолчанию разворачивается
*/
collapsed?: boolean
+
+ /**
+ * Базовый путь для дочерних элементов
+ */
+ base?: string
+
+ /**
+ * Настройте текст, который отображается в футере предыдущей/следующей страницы
+ */
+ docFooterText?: string
+
+ rel?: string
+ target?: string
}
```
-## aside {#aside}
+## aside
- Тип: `boolean | 'left'`
- По умолчанию: `true`
@@ -177,7 +190,7 @@ export type SidebarItem = {
Если вы хотите отключить его для всех режимов просмотра, используйте `aside: false`.
-## outline {#outline}
+## outline
- Тип: `Outline | Outline['level'] | false`
- Уровень можно переопределить для каждой страницы с помощью [метаданных](./frontmatter-config#outline)
@@ -205,7 +218,7 @@ interface Outline {
}
```
-## socialLinks {#sociallinks}
+## socialLinks
- Тип: `SocialLink[]`
@@ -215,6 +228,7 @@ interface Outline {
export default {
themeConfig: {
socialLinks: [
+ // Можно добавить любую иконку из simple-icons (https://simpleicons.org/):
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' },
{ icon: 'twitter', link: '...' },
// Можно добавить пользовательские иконки, передав SVG в виде строки:
@@ -239,7 +253,7 @@ interface SocialLink {
}
```
-## footer {#footer}
+## footer
- Тип: `Footer`
- Можно переопределить для каждой страницы с помощью [метаданных](./frontmatter-config#footer)
@@ -264,7 +278,7 @@ export interface Footer {
}
```
-## editLink {#editlink}
+## editLink
- Тип: `EditLink`
- Можно переопределить для каждой страницы с помощью [метаданных](./frontmatter-config#editlink)
@@ -289,7 +303,7 @@ export interface EditLink {
}
```
-## lastUpdated {#lastupdated}
+## lastUpdated
- Тип: `LastUpdatedOptions`
@@ -324,7 +338,7 @@ export interface LastUpdatedOptions {
}
```
-## algolia {#algolia}
+## algolia
- Тип: `AlgoliaSearch`
@@ -364,7 +378,7 @@ export interface CarbonAdsOptions {
Подробнее в главе [Тема по умолчанию: Carbon Ads](./default-theme-carbon-ads)
-## docFooter {#docfooter}
+## docFooter
- Тип: `DocFooter`
@@ -388,47 +402,47 @@ export interface DocFooter {
}
```
-## darkModeSwitchLabel {#darkmodeswitchlabel}
+## darkModeSwitchLabel
- Тип: `string`
- По умолчанию: `Appearance`
Можно использовать для настройки надписи переключателя тёмного режима. Этот ярлык отображается только в мобильном представлении.
-## lightModeSwitchTitle {#lightmodeswitchtitle}
+## lightModeSwitchTitle
- Тип: `string`
- По умолчанию: `Switch to light theme`
Может использоваться для настройки заголовка переключателя светлого режима, который появляется при наведении курсора.
-## darkModeSwitchTitle {#darkmodeswitchtitle}
+## darkModeSwitchTitle
- Тип: `string`
- По умолчанию: `Switch to dark theme`
Можно использовать для настройки заголовка переключателя тёмного режима, который появляется при наведении курсора.
-## sidebarMenuLabel {#sidebarmenulabel}
+## sidebarMenuLabel
- Тип: `string`
- По умолчанию: `Menu`
Может использоваться для настройки метки бокового меню. Эта метка отображается только в мобильном представлении.
-## returnToTopLabel {#returntotoplabel}
+## returnToTopLabel
- Тип: `string`
- По умолчанию: `Return to top`
Может использоваться для настройки метки кнопки возврата наверх. Эта метка отображается только в мобильном представлении.
-## langMenuLabel {#langmenulabel}
+## langMenuLabel
- Тип: `string`
- По умолчанию: `Change language`
-Можно использовать для настройки aria-метки кнопки переключения языка в панели навигации. Это используется только в том случае, если вы используете [i18n](../guide/i18n).
+Можно использовать для настройки aria-метки кнопки переключения языка в панели навигации. Применяется только в том случае, если вы используете [i18n](../guide/i18n).
## skipToContentLabel
@@ -437,9 +451,44 @@ export interface DocFooter {
Можно использовать для настройки метки ссылки перехода к содержимому. Эта ссылка отображается, когда пользователь перемещается по сайту с помощью клавиатуры.
-## externalLinkIcon {#externallinkicon}
+## externalLinkIcon
- Тип: `boolean`
- По умолчанию: `false`
Отображать ли значок внешней ссылки рядом с внешними ссылками в Markdown.
+
+## `useLayout`
+
+ sidebar: Readonly>
+ sidebarGroups: ComputedRef
+ hasSidebar: ComputedRef
+ isSidebarEnabled: ComputedRef
+
+ hasAside: ComputedRef
+ leftAside: ComputedRef
+
+ headers: Readonly>
+ hasLocalNav: ComputedRef
+}
+```
+
+**Пример:**
+
+```vue
+
+
+
+ Отображается только если есть боковая панель
+
+```
diff --git a/docs/ru/reference/default-theme-last-updated.md b/docs/ru/reference/default-theme-last-updated.md
index 7d926dc5..4a0509f4 100644
--- a/docs/ru/reference/default-theme-last-updated.md
+++ b/docs/ru/reference/default-theme-last-updated.md
@@ -2,8 +2,27 @@
Время последнего обновления содержимого будет отображаться в правом нижнем углу страницы. Чтобы включить его, добавьте опцию `lastUpdated` в свой конфиг.
-::: tip Совет
-Чтобы увидеть обновленное время, необходимо зафиксировать файл Markdown.
+::: info ПРИМЕЧАНИЕ
+VitePress отображает время «последнего обновления» на основе временной метки последнего Git-коммита для каждого файла. Для работы этой функции Markdown-файл должен быть закоммичен в Git.
+
+Внутри VitePress выполняет команду `git log -1 --pretty="%ai"` для каждого файла, чтобы получить его временную метку. Если все страницы показывают одинаковое время обновления, вероятно, это связано с поверхностным клонированием (часто встречается в CI-средах), которое ограничивает историю Git.
+
+Чтобы исправить это в **GitHub Actions**, добавьте следующее в ваш workflow-файл:
+
+```yaml{4}
+- name: Checkout
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+```
+
+Другие CI/CD-платформы имеют аналогичные настройки.
+
+Если такие опции недоступны, вы можете добавить принудительный fetch перед командой `docs:build` в вашем `package.json`:
+
+```json
+"docs:build": "git fetch --unshallow && vitepress build docs"
+```
:::
## Настройка в файле конфигурации {#site-level-config}
diff --git a/docs/ru/reference/default-theme-nav.md b/docs/ru/reference/default-theme-nav.md
index 41257de8..edfb9a9e 100644
--- a/docs/ru/reference/default-theme-nav.md
+++ b/docs/ru/reference/default-theme-nav.md
@@ -55,6 +55,8 @@ export default {
`text` — это текст, отображаемый в навигации, а `link` — это ссылка, на которую будет осуществлён переход при нажатии на текст. Для ссылки задайте путь к фактическому файлу без префикса `.md` и всегда начинайте с `/`.
+`link` также может быть функцией, которая принимает [`PageData`](./runtime-api#usedata) в качестве аргумента и возвращает путь.
+
Навигационные ссылки также могут быть выпадающими меню. Для этого установите ключ `items` вместо ключа `link`:
```js
diff --git a/docs/ru/reference/default-theme-search.md b/docs/ru/reference/default-theme-search.md
index bab3fa9e..9cdc9438 100644
--- a/docs/ru/reference/default-theme-search.md
+++ b/docs/ru/reference/default-theme-search.md
@@ -233,10 +233,16 @@ export default defineConfig({
},
modal: {
searchBox: {
- resetButtonTitle: 'Сбросить поиск',
- resetButtonAriaLabel: 'Сбросить поиск',
- cancelButtonText: 'Отменить поиск',
- cancelButtonAriaLabel: 'Отменить поиск'
+ clearButtonTitle: 'Очистить поиск',
+ clearButtonAriaLabel: 'Очистить поиск',
+ closeButtonText: 'Закрыть',
+ closeButtonAriaLabel: 'Закрыть',
+ placeholderText: 'Поиск в документации',
+ placeholderTextAskAi: 'Задайте вопрос ИИ:',
+ placeholderTextAskAiStreaming: 'Формируется ответ...',
+ searchInputLabel: 'Поиск',
+ backToKeywordSearchButtonText: 'Вернуться к поиску по ключевым словам',
+ backToKeywordSearchButtonAriaLabel: 'Вернуться к поиску по ключевым словам'
},
startScreen: {
recentSearchesTitle: 'История поиска',
@@ -244,26 +250,48 @@ export default defineConfig({
saveRecentSearchButtonTitle: 'Сохранить в истории поиска',
removeRecentSearchButtonTitle: 'Удалить из истории поиска',
favoriteSearchesTitle: 'Избранное',
- removeFavoriteSearchButtonTitle: 'Удалить из избранного'
+ removeFavoriteSearchButtonTitle: 'Удалить из избранного',
+ recentConversationsTitle: 'Последние диалоги',
+ removeRecentConversationButtonTitle: 'Удалить диалог из истории'
},
errorScreen: {
titleText: 'Невозможно получить результаты',
- helpText:
- 'Вам может потребоваться проверить подключение к Интернету'
+ helpText: 'Проверьте подключение к Интернету'
+ },
+ noResultsScreen: {
+ noResultsText: 'Ничего не найдено',
+ suggestedQueryText: 'Попробуйте изменить запрос',
+ reportMissingResultsText: 'Считаете, что результаты должны быть?',
+ reportMissingResultsLinkText: 'Сообщите об этом'
+ },
+ resultsScreen: {
+ askAiPlaceholder: 'Задайте вопрос ИИ: '
+ },
+ askAiScreen: {
+ disclaimerText: 'Ответ сгенерирован ИИ и может быть неточным. Пожалуйста, проверьте информацию самостоятельно.',
+ relatedSourcesText: 'Связанные источники',
+ thinkingText: 'Думаю...',
+ copyButtonText: 'Копировать',
+ copyButtonCopiedText: 'Скопировано!',
+ copyButtonTitle: 'Копировать',
+ likeButtonTitle: 'Нравится',
+ dislikeButtonTitle: 'Не нравится',
+ thanksForFeedbackText: 'Спасибо за ваш отзыв!',
+ preToolCallText: 'Идёт поиск...',
+ duringToolCallText: 'Поиск ',
+ afterToolCallText: 'Поиск выполнен'
},
footer: {
selectText: 'выбрать',
+ submitQuestionText: 'Отправить вопрос',
+ selectKeyAriaLabel: 'Клавиша Enter',
navigateText: 'перейти',
+ navigateUpKeyAriaLabel: 'Стрелка вверх',
+ navigateDownKeyAriaLabel: 'Стрелка вниз',
closeText: 'закрыть',
- searchByText: 'поставщик поиска'
- },
- noResultsScreen: {
- noResultsText: 'Нет результатов для',
- suggestedQueryText: 'Вы можете попытаться узнать',
- reportMissingResultsText:
- 'Считаете, что поиск даёт ложные результаты？',
- reportMissingResultsLinkText:
- 'Нажмите на кнопку «Обратная связь»'
+ backToSearchText: 'Вернуться к поиску',
+ closeKeyAriaLabel: 'Клавиша Esc',
+ poweredByText: 'поиск от'
}
}
}
@@ -277,6 +305,43 @@ export default defineConfig({
[Эти параметры](https://github.com/vuejs/vitepress/blob/main/types/docsearch.d.ts) можно переопределить. Чтобы узнать о них больше, обратитесь к официальной документации Algolia.
+### Поддержка Ask AI в Algolia {#ask-ai}
+
+Если вы хотите добавить функцию **Ask AI**, передайте параметр `askAi` (или любые из его отдельных полей) внутри объекта `options`:
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+ themeConfig: {
+ search: {
+ provider: 'algolia',
+ options: {
+ appId: '...',
+ apiKey: '...',
+ indexName: '...',
+ // askAi: "ID-ВАШЕГО-АССИСТЕНТА"
+ // ИЛИ
+ askAi: {
+ // минимум вы должны указать assistantId, полученный от Algolia
+ assistantId: 'XXXYYY',
+ // опциональные переопределения – если не указаны, используются значения appId/apiKey/indexName верхнего уровня
+ // apiKey: '...',
+ // appId: '...',
+ // indexName: '...'
+ }
+ }
+ }
+ }
+})
+```
+
+::: warning Примечание
+Если вы хотите использовать обычный поиск по ключевым словам без Ask AI, просто не указывайте свойство `askAi`
+:::
+
+Переводы для интерфейса Ask AI находятся в `options.translations.modal.askAiScreen` и `options.translations.resultsScreen` — полный список ключей смотрите в [типах](https://github.com/vuejs/vitepress/blob/main/types/docsearch.d.ts).
+
### Конфигурация поискового робота {#crawler-config}
Вот пример конфигурации, основанной на той, что используется на этом сайте:
@@ -383,4 +448,4 @@ new Crawler({
}
}
})
-```
+```
\ No newline at end of file
diff --git a/docs/ru/reference/default-theme-sidebar.md b/docs/ru/reference/default-theme-sidebar.md
index 92fd89c1..bdc6e338 100644
--- a/docs/ru/reference/default-theme-sidebar.md
+++ b/docs/ru/reference/default-theme-sidebar.md
@@ -178,36 +178,3 @@ export default {
}
}
```
-
-## `useSidebar`
- sidebar: ComputedRef
- sidebarGroups: ComputedRef
- hasSidebar: ComputedRef
- hasAside: ComputedRef
- leftAside: ComputedRef
- isSidebarEnabled: ComputedRef
- open: () => void
- close: () => void
- toggle: () => void
-}
-```
-
-**Пример:**
-
-```vue
-
-
-
- Показывать только при наличии сайдбара
-
-```
diff --git a/docs/ru/reference/default-theme-team-page.md b/docs/ru/reference/default-theme-team-page.md
index 0eebaa24..615692bb 100644
--- a/docs/ru/reference/default-theme-team-page.md
+++ b/docs/ru/reference/default-theme-team-page.md
@@ -51,12 +51,12 @@ const members = [
# Поприветствуйте нашу замечательную команду
-` поставляется в двух различных размерах, `small` и `medium`. Хотя это зависит от ваших предпочтений, обычно размер `small` лучше подходит для использования на странице с макетом `doc`. Кроме того, вы можете добавить дополнительные свойства для карточки члена команды, например, добавить «описание» или кнопку «спонсировать». Подробнее об этом в секции [``](#vpteammembers).
@@ -104,7 +104,7 @@ layout: page
которой представлены ниже.
- /.vitepress/config.[ext]`, где `` — это корень вашего [проекта](../guide/routing#root-and-source-directory) VitePress, а `[ext]` — одно из поддерживаемых расширений файла. TypeScript поддерживается из коробки. Поддерживаемые расширения включают `.js`, `.ts`, `.mjs` и `.mts`.
+Конфигурация всегда считывается из файла `/.vitepress/config.[ext]`, где `` — это корень вашего [проекта](../guide/routing#root-and-source-directory) VitePress, а `[ext]` — одно из поддерживаемых расширений файла. TypeScript поддерживается из коробки. Поддерживаемые расширения включают `.js`, `.ts`, `.mjs` и `.mts`.
В файлах конфигурации рекомендуется использовать синтаксис ES-модулей. Файл конфигурации должен по умолчанию экспортировать объект:
@@ -24,7 +24,7 @@ export default {
}
```
-:::details Динамическая (асинхронная) конфигурация
+::: details Динамическая (асинхронная) конфигурация
Если вам нужно генерировать конфигурацию динамически, вы также можете экспортировать функцию по умолчанию. Например:
@@ -458,7 +458,7 @@ export default {
### ignoreDeadLinks {#ignoredeadlinks}
-- Тип: `boolean | 'localhostLinks' | (string | RegExp | ((link: string) => boolean))[]`
+- Тип: `boolean | 'localhostLinks' | (string | RegExp | ((link: string, source: string) => boolean))[]`
- По умолчанию: `false`
Если установлено значение `true`, VitePress не будет завершать сборку из-за неработающих ссылок.
diff --git a/docs/.vitepress/config/zh.ts b/docs/zh/config.ts
similarity index 68%
rename from docs/.vitepress/config/zh.ts
rename to docs/zh/config.ts
index e9d5fbcd..f6bbdf02 100644
--- a/docs/.vitepress/config/zh.ts
+++ b/docs/zh/config.ts
@@ -1,16 +1,17 @@
import { createRequire } from 'module'
-import { defineConfig, type DefaultTheme } from 'vitepress'
+import { defineAdditionalConfig, type DefaultTheme } from 'vitepress'
const require = createRequire(import.meta.url)
const pkg = require('vitepress/package.json')
-export const zh = defineConfig({
- lang: 'zh-Hans',
+export default defineAdditionalConfig({
description: '由 Vite 和 Vue 驱动的静态站点生成器',
themeConfig: {
nav: nav(),
+ search: { options: searchOptions() },
+
sidebar: {
'/zh/guide/': { base: '/zh/guide/', items: sidebarGuide() },
'/zh/reference/': { base: '/zh/reference/', items: sidebarReference() }
@@ -23,7 +24,7 @@ export const zh = defineConfig({
footer: {
message: '基于 MIT 许可发布',
- copyright: `版权所有 © 2019-${new Date().getFullYear()} 尤雨溪`
+ copyright: '版权所有 © 2019-至今 尤雨溪'
},
docFooter: {
@@ -36,11 +37,15 @@ export const zh = defineConfig({
},
lastUpdated: {
- text: '最后更新于',
- formatOptions: {
- dateStyle: 'short',
- timeStyle: 'medium'
- }
+ text: '最后更新于'
+ },
+
+ notFound: {
+ title: '页面未找到',
+ quote:
+ '但如果你不改变方向，并且继续寻找，你可能最终会到达你所前往的地方。',
+ linkLabel: '前往首页',
+ linkText: '带我回首页'
},
langMenuLabel: '多语言',
@@ -68,6 +73,10 @@ function nav(): DefaultTheme.NavItem[] {
{
text: pkg.version,
items: [
+ {
+ text: '1.6.4',
+ link: 'https://vuejs.github.io/vitepress/v1/zh/'
+ },
{
text: '更新日志',
link: 'https://github.com/vuejs/vitepress/blob/main/CHANGELOG.md'
@@ -160,8 +169,8 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
]
}
-export const search: DefaultTheme.AlgoliaSearchOptions['locales'] = {
- zh: {
+function searchOptions(): Partial {
+ return {
placeholder: '搜索文档',
translations: {
button: {
@@ -170,10 +179,16 @@ export const search: DefaultTheme.AlgoliaSearchOptions['locales'] = {
},
modal: {
searchBox: {
- resetButtonTitle: '清除查询条件',
- resetButtonAriaLabel: '清除查询条件',
- cancelButtonText: '取消',
- cancelButtonAriaLabel: '取消'
+ clearButtonTitle: '清除查询条件',
+ clearButtonAriaLabel: '清除查询条件',
+ closeButtonText: '关闭',
+ closeButtonAriaLabel: '关闭',
+ placeholderText: '搜索文档',
+ placeholderTextAskAi: '向 AI 提问：',
+ placeholderTextAskAiStreaming: '回答中...',
+ searchInputLabel: '搜索',
+ backToKeywordSearchButtonText: '返回关键字搜索',
+ backToKeywordSearchButtonAriaLabel: '返回关键字搜索'
},
startScreen: {
recentSearchesTitle: '搜索历史',
@@ -181,23 +196,49 @@ export const search: DefaultTheme.AlgoliaSearchOptions['locales'] = {
saveRecentSearchButtonTitle: '保存至搜索历史',
removeRecentSearchButtonTitle: '从搜索历史中移除',
favoriteSearchesTitle: '收藏',
- removeFavoriteSearchButtonTitle: '从收藏中移除'
+ removeFavoriteSearchButtonTitle: '从收藏中移除',
+ recentConversationsTitle: '最近的对话',
+ removeRecentConversationButtonTitle: '从历史记录中删除对话'
},
errorScreen: {
titleText: '无法获取结果',
helpText: '你可能需要检查你的网络连接'
},
- footer: {
- selectText: '选择',
- navigateText: '切换',
- closeText: '关闭',
- searchByText: '搜索提供者'
- },
noResultsScreen: {
noResultsText: '无法找到相关结果',
suggestedQueryText: '你可以尝试查询',
reportMissingResultsText: '你认为该查询应该有结果？',
reportMissingResultsLinkText: '点击反馈'
+ },
+ resultsScreen: {
+ askAiPlaceholder: '向 AI 提问： '
+ },
+ askAiScreen: {
+ disclaimerText: '答案由 AI 生成，可能不准确，请自行验证。',
+ relatedSourcesText: '相关来源',
+ thinkingText: '思考中...',
+ copyButtonText: '复制',
+ copyButtonCopiedText: '已复制！',
+ copyButtonTitle: '复制',
+ likeButtonTitle: '赞',
+ dislikeButtonTitle: '踩',
+ thanksForFeedbackText: '感谢你的反馈！',
+ preToolCallText: '搜索中...',
+ duringToolCallText: '搜索 ',
+ afterToolCallText: '已搜索',
+ aggregatedToolCallText: '已搜索'
+ },
+ footer: {
+ selectText: '选择',
+ submitQuestionText: '提交问题',
+ selectKeyAriaLabel: 'Enter 键',
+ navigateText: '切换',
+ navigateUpKeyAriaLabel: '向上箭头',
+ navigateDownKeyAriaLabel: '向下箭头',
+ closeText: '关闭',
+ backToSearchText: '返回搜索',
+ closeKeyAriaLabel: 'Esc 键',
+ poweredByText: '搜索提供者'
}
}
}
diff --git a/docs/zh/guide/deploy.md b/docs/zh/guide/deploy.md
index db68276c..54ed13d4 100644
--- a/docs/zh/guide/deploy.md
+++ b/docs/zh/guide/deploy.md
@@ -111,7 +111,7 @@ Cache-Control: max-age=31536000,immutable
- **构建命令：** `npm run docs:build`
- **输出目录：** `docs/.vitepress/dist`
-- **node 版本：** `18` (或更高版本)
+- **node 版本：** `20` (或更高版本)
::: warning
不要为 HTML 代码启用 _Auto Minify_ 等选项。它将从输出中删除对 Vue 有意义的注释。如果被删除，你可能会看到激活不匹配错误。
@@ -163,7 +163,7 @@ Cache-Control: max-age=31536000,immutable
- name: Setup Node
uses: actions/setup-node@v4
with:
- node-version: 20
+ node-version: 22
cache: npm # 或 pnpm / yarn
- name: Setup Pages
uses: actions/configure-pages@v4
diff --git a/docs/zh/guide/extending-default-theme.md b/docs/zh/guide/extending-default-theme.md
index a40613f7..a23cebd1 100644
--- a/docs/zh/guide/extending-default-theme.md
+++ b/docs/zh/guide/extending-default-theme.md
@@ -14,7 +14,7 @@ VitePress 默认的主题已经针对文档进行了优化，并且可以进行
这些高级自定义配置将需要使用自定义主题来“拓展”默认主题。
-:::tip
+::: tip
在继续之前，请确保首先阅读[自定义主题](./custom-theme)以了解其工作原理。
:::
@@ -70,7 +70,7 @@ export default DefaultTheme
export default {
transformHead({ assets }) {
// 相应地调整正则表达式以匹配字体
- const myFontFile = assets.find(file => /font-name\.\w+\.woff2/)
+ const myFontFile = assets.find(file => /font-name\.[\w-]+\.woff2/.test(file))
if (myFontFile) {
return [
[
@@ -251,6 +251,7 @@ provide('toggle-appearance', async ({ clientX: x, clientY: y }: MouseEvent) => {
{
duration: 300,
easing: 'ease-in',
+ fill: 'forwards',
pseudoElement: `::view-transition-${isDark.value ? 'old' : 'new'}(root)`
}
)
@@ -288,7 +289,7 @@ provide('toggle-appearance', async ({ clientX: x, clientY: y }: MouseEvent) => {
```
-Result (**warning!**: flashing colors, sudden movements, bright lights):
+结果（**注意！**：画面闪烁、快速闪现、强光刺激）:
Demo
diff --git a/docs/zh/guide/getting-started.md b/docs/zh/guide/getting-started.md
index 2d6453c9..183b32df 100644
--- a/docs/zh/guide/getting-started.md
+++ b/docs/zh/guide/getting-started.md
@@ -18,39 +18,19 @@ VitePress 可以单独使用，也可以安装到现有项目中。在这两种
::: code-group
```sh [npm]
-$ npm add -D vitepress
+$ npm add -D vitepress@next
```
```sh [pnpm]
-$ pnpm add -D vitepress
+$ pnpm add -D vitepress@next
```
```sh [yarn]
-$ yarn add -D vitepress
-```
-
-```sh [yarn (pnp)]
-$ yarn add -D vitepress vue
+$ yarn add -D vitepress@next vue
```
```sh [bun]
-$ bun add -D vitepress
-```
-
-:::
-
-::: details 遇到了 missing peer deps 警告？
-如果使用 PNPM，会注意到对 `@docsearch/js` 的 missing peer deps 警告。这不会影响 VitePress 运行。如果希望禁止显示此警告，请将以下内容添加到 `package.json`：
-
-```json
-"pnpm": {
- "peerDependencyRules": {
- "ignoreMissing": [
- "@algolia/client-search",
- "search-insights"
- ]
- }
-}
+$ bun add -D vitepress@next
```
:::
@@ -89,7 +69,7 @@ $ bun vitepress init
<<< @/snippets/init.ansi
-:::tip Vue 作为 peer dependency
+::: tip Vue 作为 peer dependency
如果打算使用 Vue 组件或 API 进行自定义，还应该明确地将 `vue` 安装为 dependency。
:::
@@ -112,7 +92,7 @@ $ bun vitepress init
`docs` 目录作为 VitePress 站点的项目**根目录**。`.vitepress` 目录是 VitePress 配置文件、开发服务器缓存、构建输出和可选主题自定义代码的位置。
-:::tip
+::: tip
默认情况下，VitePress 将其开发服务器缓存存储在 `.vitepress/cache` 中，并将生产构建输出存储在 `.vitepress/dist` 中。如果使用 Git，应该将它们添加到 `.gitignore` 文件中。也可以手动[配置](../reference/site-config#outdir)这些位置。
:::
diff --git a/docs/zh/guide/markdown.md b/docs/zh/guide/markdown.md
index 308c49df..a401774c 100644
--- a/docs/zh/guide/markdown.md
+++ b/docs/zh/guide/markdown.md
@@ -255,11 +255,11 @@ Wraps in a ``
}
```
- 它在底层使用 [`postcss-prefix-selector`](https://github.com/postcss/postcss-load-config)。你可以像这样传递它的选项：
+ 你可以像这样传递它的选项：
```js
postcssIsolateStyles({
- includeFiles: [/vp-doc\.css/] // 默认为 /base\.css/
+ includeFiles: [/custom\.css/] // 默认为 [/vp-doc\.css/, /base\.css/]
})
```
@@ -343,7 +343,7 @@ export default {
在 Shiki 的代码仓库中，可以找到[合法的编程语言列表](https://shiki.style/languages)。
-还可以全局配置中自定义语法高亮主题。有关详细信息，参见 [`markdown` 选项](../reference/site-config#markdown)得到更多信息。
+还可以在全局配置中自定义语法高亮主题、配置语言别名和自定义语言标签。有关详细信息，参见 [`markdown` 选项](../reference/site-config#markdown)得到更多信息。
## 在代码块中实现行高亮 {#line-highlighting-in-code-blocks}
diff --git a/docs/zh/guide/routing.md b/docs/zh/guide/routing.md
index 56332317..c48722ad 100644
--- a/docs/zh/guide/routing.md
+++ b/docs/zh/guide/routing.md
@@ -123,7 +123,7 @@ src/getting-started.md --> /getting-started.html
## 生成简洁的 URL {#generating-clean-url}
-:::warning 需要服务器支持
+::: warning 需要服务器支持
要使 VitePress 提供简洁 URL，需要服务器端支持。
:::
diff --git a/docs/zh/guide/using-vue.md b/docs/zh/guide/using-vue.md
index be181fee..f9acaad4 100644
--- a/docs/zh/guide/using-vue.md
+++ b/docs/zh/guide/using-vue.md
@@ -67,7 +67,7 @@ The count is: {{ count }}
```
-:::warning 避免在 Markdown 中使用 `
diff --git a/src/client/theme-default/components/VPNavBarSearchButton.vue b/src/client/theme-default/components/VPNavBarSearchButton.vue
index 7a6e16f9..ee371028 100644
--- a/src/client/theme-default/components/VPNavBarSearchButton.vue
+++ b/src/client/theme-default/components/VPNavBarSearchButton.vue
@@ -2,7 +2,7 @@
import type { ButtonTranslations } from '../../../../types/local-search'
import { createSearchTranslate } from '../support/translation'
-// Button-Translations
+// button translations
const defaultTranslations: { button: ButtonTranslations } = {
button: {
buttonText: 'Search',
@@ -14,200 +14,134 @@ const translate = createSearchTranslate(defaultTranslations)
-
diff --git a/src/client/theme-default/components/VPNavBarTitle.vue b/src/client/theme-default/components/VPNavBarTitle.vue
index 1e1ef3d7..9679f8a5 100644
--- a/src/client/theme-default/components/VPNavBarTitle.vue
+++ b/src/client/theme-default/components/VPNavBarTitle.vue
@@ -2,12 +2,12 @@
import { computed } from 'vue'
import { useData } from '../composables/data'
import { useLangs } from '../composables/langs'
-import { useSidebar } from '../composables/sidebar'
+import { useLayout } from '../composables/layout'
import { normalizeLink } from '../support/utils'
import VPImage from './VPImage.vue'
const { site, theme } = useData()
-const { hasSidebar } = useSidebar()
+const { hasSidebar } = useLayout()
const { currentLang } = useLangs()
const link = computed(() =>
@@ -34,8 +34,8 @@ const target = computed(() =>
{{ currentLang.label }}
-
diff --git a/src/client/theme-default/components/VPSidebarItem.vue b/src/client/theme-default/components/VPSidebarItem.vue
index 022584e3..d71d1062 100644
--- a/src/client/theme-default/components/VPSidebarItem.vue
+++ b/src/client/theme-default/components/VPSidebarItem.vue
@@ -1,7 +1,7 @@
-
+
{{ theme.skipToContentLabel || 'Skip to content' }}
` 要素内にレンダリングされるため、
+使用できるのはインライン要素のみです。ブロック要素を追加したい場合は、
+[`layout-bottom`](../guide/extending-default-theme#layout-slots) スロットの利用を検討してください。
+:::
+
+なお、[SideBar](./default-theme-sidebar) が表示されている場合はフッターは表示されません。
+
+## フロントマターでの設定 {#frontmatter-config}
+
+ページ単位で無効化するには、フロントマターの `footer` オプションを使用します。
+
+```yaml
+---
+footer: false
+---
+```
diff --git a/docs/ja/reference/default-theme-home-page.md b/docs/ja/reference/default-theme-home-page.md
new file mode 100644
index 00000000..e472a478
--- /dev/null
+++ b/docs/ja/reference/default-theme-home-page.md
@@ -0,0 +1,188 @@
+# ホームページ {#home-page}
+
+VitePress のデフォルトテーマにはホームページ用レイアウトが用意されています（[このサイトのトップページ](../) でも使われています）。[フロントマター](./frontmatter-config) に `layout: home` を指定すれば、任意のページで利用できます。
+
+```yaml
+---
+layout: home
+---
+```
+
+ただし、この指定だけでは多くのことは起きません。`hero` や `features` などの追加オプションを設定して、ホームページにあらかじめ用意された複数の「セクション」を配置できます。
+
+## ヒーローセクション {#hero-section}
+
+ヒーローセクションはホームページの最上部に表示されます。設定例は次のとおりです。
+
+```yaml
+---
+layout: home
+
+hero:
+ name: VitePress
+ text: Vite & Vue powered static site generator.
+ tagline: 概要テキスト...
+ image:
+ src: /logo.png
+ alt: VitePress
+ actions:
+ - theme: brand
+ text: はじめる
+ link: /guide/what-is-vitepress
+ - theme: alt
+ text: GitHub で見る
+ link: https://github.com/vuejs/vitepress
+---
+```
+
+```ts
+interface Hero {
+ // `text` の上に表示される短い文字列。ブランドカラーで表示。
+ // 製品名のような短い文言を想定。
+ name?: string
+
+ // ヒーローセクションのメインテキスト。`h1` として出力。
+ text: string
+
+ // `text` の下に表示されるタグライン。
+ tagline?: string
+
+ // テキストとタグラインの横に表示する画像。
+ image?: ThemeableImage
+
+ // ヒーローに表示するアクションボタン。
+ actions?: HeroAction[]
+}
+
+type ThemeableImage =
+ | string
+ | { src: string; alt?: string }
+ | { light: string; dark: string; alt?: string }
+
+interface HeroAction {
+ // ボタンのカラーテーマ。既定は `brand`。
+ theme?: 'brand' | 'alt'
+
+ // ボタンのラベル。
+ text: string
+
+ // ボタンのリンク先。
+ link: string
+
+ // a 要素の target 属性。
+ target?: string
+
+ // a 要素の rel 属性。
+ rel?: string
+}
+```
+
+### name の色をカスタマイズする {#customizing-the-name-color}
+
+`name` にはブランドカラー（`--vp-c-brand-1`）が使われますが、`--vp-home-hero-name-color` 変数を上書きして色を変更できます。
+
+```css
+:root {
+ --vp-home-hero-name-color: blue;
+}
+```
+
+さらに、`--vp-home-hero-name-background` を組み合わせると、`name` にグラデーションを適用できます。
+
+```css
+:root {
+ --vp-home-hero-name-color: transparent;
+ --vp-home-hero-name-background: -webkit-linear-gradient(120deg, #bd34fe, #41d1ff);
+}
+```
+
+## フィーチャーセクション {#features-section}
+
+フィーチャーセクションでは、ヒーロー直下に任意の数の機能説明を並べられます。フロントマターに `features` オプションを指定して設定します。
+
+各フィーチャーにはアイコン（絵文字または画像）を指定できます。アイコンが画像（svg, png, jpeg など）の場合は、**適切な幅・高さ** を指定してください。必要に応じて説明テキストや実サイズ、ライト／ダーク用の差し替えも指定できます。
+
+```yaml
+---
+layout: home
+
+features:
+ - icon: 🛠️
+ title: いつでもシンプル＆ミニマル
+ details: 概要テキスト...
+ - icon:
+ src: /cool-feature-icon.svg
+ title: もうひとつの便利機能
+ details: 概要テキスト...
+ - icon:
+ dark: /dark-feature-icon.svg
+ light: /light-feature-icon.svg
+ title: さらに別の機能
+ details: 概要テキスト...
+---
+```
+
+```ts
+interface Feature {
+ // 各フィーチャーボックスに表示するアイコン。
+ icon?: FeatureIcon
+
+ // フィーチャーのタイトル。
+ title: string
+
+ // フィーチャーの詳細説明。
+ details: string
+
+ // フィーチャーをクリックしたときのリンク（内部・外部どちらも可）。
+ //
+ // 例: `guide/reference/default-theme-home-page` や `https://example.com`
+ link?: string
+
+ // フィーチャー内に表示するリンクテキスト。
+ // `link` と併用するのが最適。
+ //
+ // 例: `Learn more`, `Visit page` など
+ linkText?: string
+
+ // `link` 用の rel 属性。
+ //
+ // 例: `external`
+ rel?: string
+
+ // `link` 用の target 属性。
+ target?: string
+}
+
+type FeatureIcon =
+ | string
+ | { src: string; alt?: string; width?: string; height: string }
+ | {
+ light: string
+ dark: string
+ alt?: string
+ width?: string
+ height: string
+ }
+```
+
+## Markdown コンテンツ {#markdown-content}
+
+`---` で区切るフロントマターの下に Markdown を書くだけで、ホームページに追加コンテンツを表示できます。
+
+````md
+---
+layout: home
+
+hero:
+ name: VitePress
+ text: Vite & Vue powered static site generator.
+---
+
+## はじめに
+
+`npx` を使えば、すぐに VitePress を始められます！
+
+```sh
+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
new file mode 100644
index 00000000..2c85f2a8
--- /dev/null
+++ b/docs/ja/reference/default-theme-last-updated.md
@@ -0,0 +1,46 @@
+# 最終更新日時 {#last-updated}
+
+ページ右下に、コンテンツの最終更新時刻を表示できます。有効化するには、設定に `lastUpdated` オプションを追加します。
+
+::: info
+VitePress は各ファイルの **直近の Git コミットのタイムスタンプ** を用いて「最終更新」を表示します。これを有効にするには、対象の Markdown ファイルが Git にコミットされている必要があります。
+
+内部的には、各ファイルに対して `git log -1 --pretty="%ai"` を実行してタイムスタンプを取得します。すべてのページで同じ更新時刻が表示される場合、（CI 環境でよくある）**浅いクローン（shallow clone）** により Git の履歴が取得できていない可能性があります。
+
+**GitHub Actions** での修正例は次のとおりです。
+
+```yaml{4}
+- name: Checkout
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+```
+
+他の CI/CD プラットフォームでも同様の設定が用意されています。
+
+もしそのようなオプションが使えない場合は、`package.json` のビルドスクリプトで手動フェッチを前置してください。
+
+```json
+"docs:build": "git fetch --unshallow && vitepress build docs"
+```
+:::
+
+## サイトレベルの設定 {#site-level-config}
+
+```js
+export default {
+ lastUpdated: true
+}
+```
+
+## フロントマターでの設定 {#frontmatter-config}
+
+ページ単位で無効化するには、フロントマターで `lastUpdated` を指定します。
+
+```yaml
+---
+lastUpdated: false
+---
+```
+
+より詳しくは [デフォルトテーマ: 最終更新](./default-theme-config#lastupdated) を参照してください。テーマレベルで truthy な値を設定すると、サイトまたはページで明示的に無効化しない限り、この機能は有効になります。
diff --git a/docs/ja/reference/default-theme-layout.md b/docs/ja/reference/default-theme-layout.md
new file mode 100644
index 00000000..e241d03e
--- /dev/null
+++ b/docs/ja/reference/default-theme-layout.md
@@ -0,0 +1,62 @@
+# レイアウト {#layout}
+
+ページの [フロントマター](./frontmatter-config) の `layout` オプションでページのレイアウトを選択できます。利用可能なレイアウトは `doc`、`page`、`home` の 3 種類です。何も指定しない場合は `doc` として扱われます。
+
+```yaml
+---
+layout: doc
+---
+```
+
+## Doc レイアウト {#doc-layout}
+
+`doc` は既定のレイアウトで、Markdown 全体を「ドキュメント」風にスタイリングします。コンテンツ全体を `vp-doc` という CSS クラスでラップし、その配下の要素にスタイルを適用します。
+
+`p` や `h2` などほぼすべての汎用要素に特別なスタイルが当たります。そのため、Markdown 内にカスタム HTML を追加した場合も、これらのスタイルの影響を受ける点に注意してください。
+
+また、以下のようなドキュメント特有の機能も提供します。これらはこのレイアウトでのみ有効になります。
+
+- 編集リンク（Edit Link）
+- 前後リンク（Prev / Next Link）
+- アウトライン（Outline）
+- [Carbon 広告](./default-theme-carbon-ads)
+
+## Page レイアウト {#page-layout}
+
+`page` は「ブランクページ」として扱われます。Markdown はパースされ、[Markdown 拡張](../guide/markdown) も `doc` と同様に機能しますが、既定のスタイルは適用されません。
+
+このレイアウトでは、VitePress テーマにマークアップを干渉させず、すべてを自分でスタイルできます。独自のカスタムページを作成したい場合に便利です。
+
+なお、このレイアウトでも、ページがサイドバー設定に一致する場合はサイドバーが表示されます。
+
+## Home レイアウト {#home-layout}
+
+`home` はテンプレート化された「ホームページ」を生成します。このレイアウトでは、`hero` や `features` などの追加オプションでコンテンツをさらにカスタマイズできます。詳しくは [デフォルトテーマ: ホームページ](./default-theme-home-page) を参照してください。
+
+## レイアウトなし {#no-layout}
+
+レイアウトを一切適用したくない場合は、フロントマターで `layout: false` を指定します。これは（既定でサイドバー／ナビバー／フッターなしの）完全にカスタマイズ可能なランディングページを作りたい場合に役立ちます。
+
+## カスタムレイアウト {#custom-layout}
+
+カスタムレイアウトを使用することもできます。
+
+```md
+---
+layout: foo
+---
+```
+
+これは、コンテキストに登録された `foo` という名前のコンポーネントを探します。たとえば、`.vitepress/theme/index.ts` でグローバル登録できます。
+
+```ts
+import DefaultTheme from 'vitepress/theme'
+import Foo from './Foo.vue'
+
+export default {
+ extends: DefaultTheme,
+ enhanceApp({ app }) {
+ app.component('foo', Foo)
+ }
+}
+```
diff --git a/docs/ja/reference/default-theme-nav.md b/docs/ja/reference/default-theme-nav.md
new file mode 100644
index 00000000..207bf9e9
--- /dev/null
+++ b/docs/ja/reference/default-theme-nav.md
@@ -0,0 +1,215 @@
+# ナビゲーション {#nav}
+
+ナビはページ上部に表示されるナビゲーションバーです。サイトタイトル、グローバルメニューリンクなどを含みます。
+
+## サイトタイトルとロゴ {#site-title-and-logo}
+
+既定では、ナビには [`config.title`](./site-config#title) の値が表示されます。ナビに表示する文字列を変更したい場合は、`themeConfig.siteTitle` にカスタム文字列を指定します。
+
+```js
+export default {
+ themeConfig: {
+ siteTitle: 'My Custom Title'
+ }
+}
+```
+
+サイトのロゴがある場合は、画像へのパスを渡すと表示できます。ロゴは `public` 直下に配置し、絶対パスで指定してください。
+
+```js
+export default {
+ themeConfig: {
+ logo: '/my-logo.svg'
+ }
+}
+```
+
+ロゴを追加すると、サイトタイトルと並んで表示されます。ロゴだけを表示したい場合は、`siteTitle` を `false` に設定してタイトル文字列を非表示にできます。
+
+```js
+export default {
+ themeConfig: {
+ logo: '/my-logo.svg',
+ siteTitle: false
+ }
+}
+```
+
+ダーク／ライトモードでロゴを切り替えたり、`alt` 属性を付けたい場合は、ロゴにオブジェクトを渡すこともできます。詳細は [`themeConfig.logo`](./default-theme-config#logo) を参照してください。
+
+## ナビゲーションリンク {#navigation-links}
+
+`themeConfig.nav` オプションでナビにリンクを追加できます。
+
+```js
+export default {
+ themeConfig: {
+ nav: [
+ { text: 'Guide', link: '/guide' },
+ { text: 'Config', link: '/config' },
+ { text: 'Changelog', link: 'https://github.com/...' }
+ ]
+ }
+}
+```
+
+`text` はナビに表示される文字列、`link` はクリック時に遷移するリンクです。内部リンクは `.md` 拡張子を付けず、必ず `/` で始めるようにしてください。
+
+`link` には、[`PageData`](./runtime-api#usedata) を受け取ってパスを返す関数を指定することもできます。
+
+ナビリンクはドロップダウンメニューにもできます。リンクオプションに `items` を設定してください。
+
+```js
+export default {
+ themeConfig: {
+ nav: [
+ { text: 'Guide', link: '/guide' },
+ {
+ text: 'Dropdown Menu',
+ items: [
+ { text: 'Item A', link: '/item-1' },
+ { text: 'Item B', link: '/item-2' },
+ { text: 'Item C', link: '/item-3' }
+ ]
+ }
+ ]
+ }
+}
+```
+
+なお、ドロップダウンのタイトル（上の例の `Dropdown Menu`）には `link` は設定できません。ドロップダウンを開くボタンになるためです。
+
+さらに、ドロップダウン内を「セクション」に分けることもできます（入れ子の `items` を使います）。
+
+```js
+export default {
+ themeConfig: {
+ nav: [
+ { text: 'Guide', link: '/guide' },
+ {
+ text: 'Dropdown Menu',
+ items: [
+ {
+ // セクションのタイトル
+ text: 'Section A Title',
+ items: [
+ { text: 'Section A Item A', link: '...' },
+ { text: 'Section B Item B', link: '...' }
+ ]
+ }
+ ]
+ },
+ {
+ text: 'Dropdown Menu',
+ items: [
+ {
+ // タイトルは省略することも可能
+ items: [
+ { text: 'Section A Item A', link: '...' },
+ { text: 'Section B Item B', link: '...' }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+}
+```
+
+### リンクの「アクティブ」状態をカスタマイズ {#customize-link-s-active-state}
+
+現在のページが特定のパス配下にあるとき、該当するナビ項目がハイライトされます。一致させるパスをカスタマイズしたい場合は、`activeMatch` に **正規表現文字列** を指定します。
+
+```js
+export default {
+ themeConfig: {
+ nav: [
+ // ユーザーが `/config/` 配下にいるときにアクティブになる
+ {
+ text: 'Guide',
+ link: '/guide',
+ activeMatch: '/config/'
+ }
+ ]
+ }
+}
+```
+
+::: warning
+`activeMatch` は正規表現 **オブジェクト** ではなく、**文字列** で指定してください。ビルド時のシリアライズの都合で `RegExp` は使用できません。
+:::
+
+### リンクの `target` と `rel` をカスタマイズ {#customize-link-s-target-and-rel-attributes}
+
+既定では、リンクが外部かどうかに応じて VitePress が `target` と `rel` を自動設定します。必要であれば明示的に指定することもできます。
+
+```js
+export default {
+ themeConfig: {
+ nav: [
+ {
+ text: 'Merchandise',
+ link: 'https://www.thegithubshop.com/',
+ target: '_self',
+ rel: 'sponsored'
+ }
+ ]
+ }
+}
+```
+
+## ソーシャルリン� {#social-links}
+
+[`socialLinks`](./default-theme-config#sociallinks) を参照してください。
+
+## カスタムコンポーネント {#custom-components}
+
+`component` オプションを使って、ナビゲーションバーにカスタムコンポーネントを配置できます。`component` には Vue コンポーネント名を指定し、[Theme.enhanceApp](../guide/custom-theme#theme-interface) で **グローバル登録** しておく必要があります。
+
+```js [.vitepress/config.js]
+export default {
+ themeConfig: {
+ nav: [
+ {
+ text: 'My Menu',
+ items: [
+ {
+ component: 'MyCustomComponent',
+ // コンポーネントに渡す任意の props
+ props: {
+ title: 'My Custom Component'
+ }
+ }
+ ]
+ },
+ {
+ component: 'AnotherCustomComponent'
+ }
+ ]
+ }
+}
+```
+
+次に、コンポーネントをグローバル登録します。
+
+```js [.vitepress/theme/index.js]
+import DefaultTheme from 'vitepress/theme'
+
+import MyCustomComponent from './components/MyCustomComponent.vue'
+import AnotherCustomComponent from './components/AnotherCustomComponent.vue'
+
+/** @type {import('vitepress').Theme} */
+export default {
+ extends: DefaultTheme,
+ enhanceApp({ app }) {
+ app.component('MyCustomComponent', MyCustomComponent)
+ app.component('AnotherCustomComponent', AnotherCustomComponent)
+ }
+}
+```
+
+コンポーネントはナビゲーションバー内にレンダリングされます。VitePress は次の追加 props をコンポーネントに提供します。
+
+- `screenMenu`: モバイルのナビメニュー内にあるかどうかを示す任意の boolean
+
+e2e テスト内の例は[こちら](https://github.com/vuejs/vitepress/tree/main/__tests__/e2e/.vitepress)を参照してください。
diff --git a/docs/ja/reference/default-theme-prev-next-links.md b/docs/ja/reference/default-theme-prev-next-links.md
new file mode 100644
index 00000000..7b15d699
--- /dev/null
+++ b/docs/ja/reference/default-theme-prev-next-links.md
@@ -0,0 +1,43 @@
+# 前／次リンク {#prev-next-links}
+
+ドキュメントのフッターに表示される「前のページ」「次のページ」のテキストとリンクをカスタマイズできます。サイドバーに表示しているタイトルとは別の文言を使いたい場合や、フッターを無効化したり、サイドバーに含まれていないページへリンクしたい場合に便利です。
+
+## prev
+
+- 型: `string | false | { text?: string; link?: string }`
+
+- 詳細:
+
+ 前のページへのリンクに表示するテキスト／リンクを指定します。フロントマターで設定しない場合は、サイドバー設定から自動推測されます。
+
+- 例:
+
+ - テキストだけをカスタマイズ:
+
+ ```yaml
+ ---
+ prev: 'Get Started | Markdown'
+ ---
+ ```
+
+ - テキストとリンクの両方をカスタマイズ:
+
+ ```yaml
+ ---
+ prev:
+ text: 'Markdown'
+ link: '/guide/markdown'
+ ---
+ ```
+
+ - 前のページを非表示にする:
+
+ ```yaml
+ ---
+ prev: false
+ ---
+ ```
+
+## next
+
+`prev` と同様ですが、次のページ用の設定です。
diff --git a/docs/ja/reference/default-theme-search.md b/docs/ja/reference/default-theme-search.md
new file mode 100644
index 00000000..e15de4ef
--- /dev/null
+++ b/docs/ja/reference/default-theme-search.md
@@ -0,0 +1,451 @@
+---
+outline: deep
+---
+
+# 検索 {#search}
+
+## ローカル検索 {#local-search}
+
+VitePress は、[minisearch](https://github.com/lucaong/minisearch/) によるブラウザ内インデックスを使った曖昧一致の全文検索をサポートします。有効化するには、`.vitepress/config.ts` で `themeConfig.search.provider` を `'local'` に設定します。
+
+```ts
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+ themeConfig: {
+ search: {
+ provider: 'local'
+ }
+ }
+})
+```
+
+表示例:
+
+
+
+代わりに [Algolia DocSearch](#algolia-search) や、次のコミュニティ製プラグインを使うこともできます。
+
+- ` 태그 안에 래핑됩니다. ` `는 블록 엘리먼트를 내부에 배치할 수 없기 때문에 하이드레이션 불일치가 발생합니다.
+커스텀 컴포넌트의 이름에 하이픈이 포함되어 있거나 파스칼케이스(PascalCase)인지 확인하세요. 그렇지 않으면 인라인 요소로 처리되어 ` ` 태그 안에 래핑됩니다. ` `는 블록 엘리먼트를 내부에 배치할 수 없기 때문에 하이드레이션 불일치가 발생합니다.
:::
### 헤더에 `, o que levará a uma incompatibilidade de hidratação pois ` ` não permite que elementos de bloco sejam colocados dentro dele.
:::
-### Usando Componentes Em Cabeçalhos {{ currentLang.label }}` 見出しになります。`#title` と `#lead` スロットでチームについて説明を書きましょう。
+
+`
{{ theme.footer.copyright }}
+
+```
+
+## `useRoute` Custom Layout!
+ ` 見出しのテキストに、グローバルの `title` をサフィックスとして結合したものになります。次の設定とページ内容の例:
+
+```ts
+export default {
+ title: 'My Awesome Site'
+}
+```
+
+```md
+# Hello
+```
+
+このページのタイトルは `Hello | My Awesome Site` になります。
+
+### titleTemplate
+
+- 型: `string | boolean`
+- ページ単位での上書き: [frontmatter](./frontmatter-config#titletemplate)
+
+各ページタイトルのサフィックス、またはタイトル全体のカスタマイズができます。例:
+
+```ts
+export default {
+ title: 'My Awesome Site',
+ titleTemplate: 'Custom Suffix'
+}
+```
+
+```md
+# Hello
+```
+
+このページのタイトルは `Hello | Custom Suffix` になります。
+
+タイトルの描画方法を完全にカスタマイズするには、`titleTemplate` 内で `:title` シンボルを使います。
+
+```ts
+export default {
+ titleTemplate: ':title - Custom Suffix'
+}
+```
+
+ここで `:title` はページ先頭の `
` から推論されたテキストに置き換えられます。先ほどの例では `Hello - Custom Suffix` になります。
+
+`false` を設定するとタイトルのサフィックスを無効にできます。
+
+### description
+
+- 型: `string`
+- 既定値: `A VitePress site`
+- ページ単位での上書き: [frontmatter](./frontmatter-config#description)
+
+サイトの説明。ページの HTML に `` タグとして出力されます。
+
+```ts
+export default {
+ description: 'A VitePress site'
+}
+```
+
+### head
+
+- 型: `HeadConfig[]`
+- 既定値: `[]`
+- ページ単位での追加: [frontmatter](./frontmatter-config#head)
+
+ページ HTML の `` に追加で出力する要素。ユーザーが追加したタグは、VitePress のタグの後、`` の直前にレンダリングされます。
+
+```ts
+type HeadConfig =
+ | [string, Record
Demo
diff --git a/docs/zh/guide/getting-started.md b/docs/zh/guide/getting-started.md
index 2d6453c9..183b32df 100644
--- a/docs/zh/guide/getting-started.md
+++ b/docs/zh/guide/getting-started.md
@@ -18,39 +18,19 @@ VitePress 可以单独使用，也可以安装到现有项目中。在这两种
::: code-group
```sh [npm]
-$ npm add -D vitepress
+$ npm add -D vitepress@next
```
```sh [pnpm]
-$ pnpm add -D vitepress
+$ pnpm add -D vitepress@next
```
```sh [yarn]
-$ yarn add -D vitepress
-```
-
-```sh [yarn (pnp)]
-$ yarn add -D vitepress vue
+$ yarn add -D vitepress@next vue
```
```sh [bun]
-$ bun add -D vitepress
-```
-
-:::
-
-::: details 遇到了 missing peer deps 警告？
-如果使用 PNPM，会注意到对 `@docsearch/js` 的 missing peer deps 警告。这不会影响 VitePress 运行。如果希望禁止显示此警告，请将以下内容添加到 `package.json`：
-
-```json
-"pnpm": {
- "peerDependencyRules": {
- "ignoreMissing": [
- "@algolia/client-search",
- "search-insights"
- ]
- }
-}
+$ bun add -D vitepress@next
```
:::
@@ -89,7 +69,7 @@ $ bun vitepress init
<<< @/snippets/init.ansi
-:::tip Vue 作为 peer dependency
+::: tip Vue 作为 peer dependency
如果打算使用 Vue 组件或 API 进行自定义，还应该明确地将 `vue` 安装为 dependency。
:::
@@ -112,7 +92,7 @@ $ bun vitepress init
`docs` 目录作为 VitePress 站点的项目**根目录**。`.vitepress` 目录是 VitePress 配置文件、开发服务器缓存、构建输出和可选主题自定义代码的位置。
-:::tip
+::: tip
默认情况下，VitePress 将其开发服务器缓存存储在 `.vitepress/cache` 中，并将生产构建输出存储在 `.vitepress/dist` 中。如果使用 Git，应该将它们添加到 `.gitignore` 文件中。也可以手动[配置](../reference/site-config#outdir)这些位置。
:::
diff --git a/docs/zh/guide/markdown.md b/docs/zh/guide/markdown.md
index 308c49df..a401774c 100644
--- a/docs/zh/guide/markdown.md
+++ b/docs/zh/guide/markdown.md
@@ -255,11 +255,11 @@ Wraps in a `