diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index dc527e35..51d3fffe 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -18,7 +18,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest]
- node_version: [18, 20, 22]
+ node_version: [20, 22, latest]
include:
- os: windows-latest
node_version: 22
diff --git a/__tests__/e2e/.vitepress/theme/components/ApiPreference.vue b/__tests__/e2e/.vitepress/theme/components/ApiPreference.vue
index 12207764..c286640b 100644
--- a/__tests__/e2e/.vitepress/theme/components/ApiPreference.vue
+++ b/__tests__/e2e/.vitepress/theme/components/ApiPreference.vue
@@ -30,7 +30,7 @@ function removeSpaces(str: string) {
diff --git a/docs/en/guide/deploy.md b/docs/en/guide/deploy.md
index a4093df2..ed6331c1 100644
--- a/docs/en/guide/deploy.md
+++ b/docs/en/guide/deploy.md
@@ -111,7 +111,7 @@ Set up a new project and change these settings using your dashboard:
- **Build Command:** `npm run docs:build`
- **Output Directory:** `docs/.vitepress/dist`
-- **Node Version:** `18` (or above)
+- **Node Version:** `20` (or above)
::: warning
Don't enable options like _Auto Minify_ for HTML code. It will remove comments from output which have meaning to Vue. You may see hydration mismatch errors if they get removed.
@@ -163,7 +163,7 @@ Don't enable options like _Auto Minify_ for HTML code. It will remove comments f
- name: Setup Node
uses: actions/setup-node@v4
with:
- node-version: 20
+ node-version: 22
cache: npm # or pnpm / yarn
- name: Setup Pages
uses: actions/configure-pages@v4
diff --git a/docs/en/reference/default-theme-config.md b/docs/en/reference/default-theme-config.md
index c8afc554..8f71d4af 100644
--- a/docs/en/reference/default-theme-config.md
+++ b/docs/en/reference/default-theme-config.md
@@ -457,3 +457,38 @@ Can be used to customize the label of the skip to content link. This link is sho
- Default: `false`
Whether to show an external link icon next to external links in markdown.
+
+## `useLayout`
+
+Returns layout-related data. The returned object has the following type:
+
+```ts
+interface {
+ isHome: ComputedRef
+
+ sidebar: ComputedRef
+ sidebarGroups: ComputedRef
+ hasSidebar: ComputedRef
+ isSidebarEnabled: ComputedRef
+
+ hasAside: ComputedRef
+ leftAside: ComputedRef
+
+ headers: ShallowRef
+ hasLocalNav: ComputedRef
+}
+```
+
+**Example:**
+
+```vue
+
+
+
+
-
-```
diff --git a/docs/en/reference/default-theme-team-page.md b/docs/en/reference/default-theme-team-page.md
index 29b071ff..6c37c6a7 100644
--- a/docs/en/reference/default-theme-team-page.md
+++ b/docs/en/reference/default-theme-team-page.md
@@ -53,12 +53,12 @@ const members = [
Say hello to our awesome team.
-
+
```
The above will display a team member in card looking element. It should display something similar to below.
-
+
`` component comes in 2 different sizes, `small` and `medium`. While it boils down to your preference, usually `small` size should fit better when used in doc page. Also, you may add more properties to each member such as adding "description" or "sponsor" button. Learn more about it in [``](#vpteammembers).
@@ -107,9 +107,7 @@ const members = [
team, some of whom have chosen to be featured below.
-
+
```
diff --git a/docs/en/reference/frontmatter-config.md b/docs/en/reference/frontmatter-config.md
index 955d4ad7..4d6f86c0 100644
--- a/docs/en/reference/frontmatter-config.md
+++ b/docs/en/reference/frontmatter-config.md
@@ -225,3 +225,16 @@ Then you can customize styles of this specific page in `.vitepress/theme/custom.
/* page-specific styles */
}
```
+
+### isHome
+
+- Type: `boolean`
+
+The default theme relies on checks like `frontmatter.layout === 'home'` to determine if the current page is the home page.\
+This is useful when you want to force show the home page elements in a custom layout.
+
+```yaml
+---
+isHome: true
+---
+```
diff --git a/docs/es/guide/deploy.md b/docs/es/guide/deploy.md
index 005f05c9..5d2c9c06 100644
--- a/docs/es/guide/deploy.md
+++ b/docs/es/guide/deploy.md
@@ -163,7 +163,7 @@ No active opciones como _Auto Minify_ para código HTML. Eso removera comentario
- name: Setup Node
uses: actions/setup-node@v4
with:
- node-version: 20
+ node-version: 22
cache: npm # o pnpm / yarn
- name: Setup Pages
uses: actions/configure-pages@v4
diff --git a/docs/es/reference/default-theme-sidebar.md b/docs/es/reference/default-theme-sidebar.md
index cf2af04b..41cd5cac 100644
--- a/docs/es/reference/default-theme-sidebar.md
+++ b/docs/es/reference/default-theme-sidebar.md
@@ -181,36 +181,3 @@ export default {
}
}
```
-
-## `useSidebar`
-
-Devuelve datos relacionados con la barra lateral. El objeto devuelto tiene el siguiente tipo:
-
-```ts
-export interface DocSidebar {
- isOpen: Ref
- sidebar: ComputedRef
- sidebarGroups: ComputedRef
- hasSidebar: ComputedRef
- hasAside: ComputedRef
- leftAside: ComputedRef
- isSidebarEnabled: ComputedRef
- open: () => void
- close: () => void
- toggle: () => void
-}
-```
-
-**Exemplo:**
-
-```vue
-
-
-
-
Sólo visible cuando existe la barra lateral
-
-```
diff --git a/docs/es/reference/default-theme-team-page.md b/docs/es/reference/default-theme-team-page.md
index 1f6492a8..996e8f18 100644
--- a/docs/es/reference/default-theme-team-page.md
+++ b/docs/es/reference/default-theme-team-page.md
@@ -53,12 +53,12 @@ const members = [
Saluda a nuestro increible equipo.
-
+
```
El código anterior mostrará a un miembro del equipo en un elemento similar a una tarjeta. Debería mostrar algo similar a lo siguiente.
-
+
El componente `` viene en dos tamaños diferentes, pequeño `small` y médio `medium`. Si bien es una cuestión de preferencia, generalmente el tamaño `small` debería encajar mejor cuando se use en la página del documento. Además, puede agregar más propiedades a cada miembro, como agregar el botón "descripción" o "patrocinador". Obtenga más información sobre en [``](#vpteammembers).
@@ -107,9 +107,7 @@ const members = [
Algunos de los miembros han elegido aparecer a continuación.
-
+
```
diff --git a/docs/fa/guide/deploy.md b/docs/fa/guide/deploy.md
index dcc74f69..1b89f334 100644
--- a/docs/fa/guide/deploy.md
+++ b/docs/fa/guide/deploy.md
@@ -161,7 +161,7 @@ Cache-Control: max-age=31536000,immutable
- name: Setup Node
uses: actions/setup-node@v4
with:
- node-version: 20
+ node-version: 22
cache: npm # or pnpm / yarn
- name: Setup Pages
uses: actions/configure-pages@v4
diff --git a/docs/fa/reference/default-theme-sidebar.md b/docs/fa/reference/default-theme-sidebar.md
index cba65dff..96433c2d 100644
--- a/docs/fa/reference/default-theme-sidebar.md
+++ b/docs/fa/reference/default-theme-sidebar.md
@@ -178,38 +178,3 @@ export default {
}
}
```
-
-## `useSidebar` {#usesidebar}
-
-دادههای مربوط به نوار کناری را برمیگرداند. شیء برگردانده شده دارای نوعهای زیر است:
-
-```ts
-export interface DocSidebar {
- isOpen: Ref
- sidebar: ComputedRef
- sidebarGroups: ComputedRef
- hasSidebar: ComputedRef
- hasAside: ComputedRef
- leftAside: ComputedRef
- isSidebarEnabled: ComputedRef
- open: () => void
- close: () => void
- toggle: () => void
-}
-```
-
-**مثال:**
-
-```vue
-
-
-
-
فقط ن
-
-مایش داده شود زمانی که نوار کناری وجود دارد
-
-```
diff --git a/docs/fa/reference/default-theme-team-page.md b/docs/fa/reference/default-theme-team-page.md
index ccd9738d..57fc2814 100644
--- a/docs/fa/reference/default-theme-team-page.md
+++ b/docs/fa/reference/default-theme-team-page.md
@@ -53,12 +53,12 @@ const members = [
با سلام به تیم فوقالعادهی ما خوش آمدید.
-
+
```
بالا به صورت عنصری با شکل کارتی اعضای تیم را نمایش میدهد. باید به شکل زیر نمایش داده شود.
-
+
کامپوننت `` دارای دو اندازه مختلف، `small` و `medium` است. معمولاً اندازه `small` برای استفاده در صفحات مستندات مناسبتر است. همچنین میتوانید ویژگیهای بیشتری برای هر عضو اضافه کنید مانند "توضیحات" یا "دکمه حامی". جهت کسب اطلاعات بیشتر به [``](#vpteammembers) مراجعه کنید.
@@ -106,9 +106,7 @@ const members = [
توسعه ویتپرس توسط تیمی بینالمللی راهنمایی میشود، برخی از اعضا که انتخاب کردهاند تا در زیر نمایش داده شوند.
-
+
```
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/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`
-
-사이드바 관련 데이터를 반환합니다. 반환된 객체는 다음과 같은 타입을 가집니다:
-
-```ts
-export interface DocSidebar {
- isOpen: Ref
- 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/package.json b/docs/package.json
index d3c19d0c..18ffeb9c 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -15,6 +15,6 @@
"open-cli": "^8.0.0",
"postcss-rtlcss": "^5.6.0",
"vitepress": "workspace:*",
- "vitepress-plugin-group-icons": "^1.3.6"
+ "vitepress-plugin-group-icons": "^1.3.8"
}
}
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/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`
-
-Retorna dados relacionados à barra lateral. O objeto retornado tem o seguinte tipo:
-
-```ts
-export interface DocSidebar {
- isOpen: Ref
- 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.
-
+
```
O código acima exibirá um membro da equipe em um elemento tipo cartão. Ele deve exibir algo semelhante ao abaixo.
-
+
O componente `` 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/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/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` {#usesidebar}
-
-Возвращает данные, связанные с сайдбаром. Возвращаемый объект имеет следующий тип:
-
-```ts
-export interface DocSidebar {
- isOpen: Ref
- 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
которой представлены ниже.
-
+
```
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/reference/default-theme-sidebar.md b/docs/zh/reference/default-theme-sidebar.md
index ba9a9adc..e353ef78 100644
--- a/docs/zh/reference/default-theme-sidebar.md
+++ b/docs/zh/reference/default-theme-sidebar.md
@@ -178,36 +178,3 @@ export default {
}
}
```
-
-## `useSidebar`
-
-返回侧边栏相关数据。返回的对象具有以下类型:
-
-```ts
-export interface DocSidebar {
- isOpen: Ref
- sidebar: ComputedRef
- sidebarGroups: ComputedRef
- hasSidebar: ComputedRef
- hasAside: ComputedRef
- leftAside: ComputedRef
- isSidebarEnabled: ComputedRef
- open: () => void
- close: () => void
- toggle: () => void
-}
-```
-
-**示例:**
-
-```vue
-
-
-
-