Skip to content

Commit d2696f7

Browse files
committed
docs: rename routeMeta to meta and update description
1 parent d61dd76 commit d2696f7

File tree

6 files changed

+20
-22
lines changed

6 files changed

+20
-22
lines changed

docs/reference/frontmatter.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -189,16 +189,16 @@ Then the permalink of the page would be `2021/01/03/bar-baz.html`.
189189
- [Frontmatter > permalink](#permalink)
190190
- [Node API > Page Properties > permalink](./node-api.md#permalink)
191191

192-
## routeMeta
192+
## meta
193193

194194
- Type: `Record<string, unknown>`
195195

196196
- Details:
197197

198-
Custom data to be attached to the page route.
198+
Custom data to be attached to the page.
199199

200200
- Also see:
201-
- [Node API > Page Properties > routeMeta](./node-api.md#routeMeta)
201+
- [Node API > Page Properties > meta](./node-api.md#meta)
202202

203203
## title
204204

docs/reference/node-api.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -601,22 +601,21 @@ interface MarkdownLink {
601601
- [Frontmatter > permalink](./frontmatter.md#permalink)
602602
- [Frontmatter > permalinkPattern](./frontmatter.md#permalinkpattern)
603603

604-
### routeMeta
604+
### meta
605605

606606
- Type: `Record<string, unknown>`
607607

608608
- Details:
609609

610-
Custom data to be attached to the route record of vue-router.
610+
Custom data to be attached to the page route.
611611

612612
- Also see:
613-
- [Frontmatter > routeMeta](./frontmatter.md#routemeta)
614-
- [vue-router > API Reference > RouteRecordRaw > meta](https://router.vuejs.org/api/#meta)
613+
- [Frontmatter > meta](./frontmatter.md#meta)
615614

616-
::: tip What's the difference between route meta and page data?
617-
Both [route meta](#routemeta) and [page data](#data) is available in client side. However, route meta is attached to the route record, so the route meta of all pages would be loaded at once when users enter your site. In the contrast, page data is saved in separated files, which would be loaded only when users enter the corresponding page.
615+
::: tip What's the difference between page meta and page data?
616+
Both [page meta](#meta) and [page data](#data) is available in client side. However, route meta is attached to the page routes records, so the page meta of all pages would be loaded at once when users enter your site. In the contrast, page data is saved in separated files, which would be loaded only when users enter the corresponding page.
618617

619-
Therefore, it's not recommended to store large amounts of info into route meta, otherwise the initial loading speed will be affected a lot when your site has a large number of pages.
618+
Therefore, it's not recommended to store large amounts of info into page meta, otherwise the initial loading speed will be affected a lot when your site has a large number of pages.
620619
:::
621620

622621
### sfcBlocks

docs/reference/plugin-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ export default {
295295

296296
This hook can be used for adding extra properties or modifying current properties on `Page` object.
297297

298-
Notice that changes to `page.data` and `page.routeMeta` can be used in client side code.
298+
Notice that changes to `page.data` and `page.meta` can be used in client side code.
299299

300300
- Example:
301301

@@ -324,7 +324,7 @@ export default {
324324
- Also see:
325325
- [Client API > usePageData](./client-api.md#usepagedata)
326326
- [Node API > Page Properties > data](./node-api.md#data)
327-
- [Node API > Page Properties > routeMeta](./node-api.md#routemeta)
327+
- [Node API > Page Properties > meta](./node-api.md#meta)
328328

329329
## Lifecycle Hooks
330330

docs/zh/reference/frontmatter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ permalinkPattern: :year/:month/:day/:slug.html
189189
- [Frontmatter > permalink](#permalink)
190190
- [Node API > Page 属性 > permalink](./node-api.md#permalink)
191191

192-
## routeMeta
192+
## meta
193193

194194
- 类型: `Record<string, unknown>`
195195

@@ -198,7 +198,7 @@ permalinkPattern: :year/:month/:day/:slug.html
198198
附加到页面路由的自定义数据。
199199

200200
- 参考:
201-
- [Node API > Page 属性 > routeMeta](./node-api.md#routeMeta)
201+
- [Node API > Page 属性 > meta](./node-api.md#meta)
202202

203203
## title
204204

docs/zh/reference/node-api.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -599,7 +599,7 @@ interface MarkdownLink {
599599
- [Frontmatter > permalink](./frontmatter.md#permalink)
600600
- [Frontmatter > permalinkPattern](./frontmatter.md#permalinkpattern)
601601

602-
### routeMeta
602+
### meta
603603

604604
- 类型: `Record<string, unknown>`
605605

@@ -608,13 +608,12 @@ interface MarkdownLink {
608608
附加到 vue-router 路由记录上的额外数据。
609609

610610
- 参考:
611-
- [Frontmatter > routeMeta](./frontmatter.md#routemeta)
612-
- [vue-router > API 参考 > RouteRecordRaw > meta](https://router.vuejs.org/zh/api/#meta)
611+
- [Frontmatter > meta](./frontmatter.md#meta)
613612

614-
::: tip Route Meta 和 Page Data 的区别是什么?
615-
[Route Meta](#routemeta)[Page Data](#data) 都可以在客户端代码中使用。然而, Route Meta 是附加在路由记录上的,因此当用户进入你的站点时,所有页面的 Route Meta 都会立即被加载。相比之下, Page Data 是存储在单独的文件中的,只有在用户进入对应页面时才会被加载。
613+
::: tip Page Meta 和 Page Data 的区别是什么?
614+
[Page Meta](#meta)[Page Data](#data) 都可以在客户端代码中使用。然而, Page Meta 是附加在页面路由记录上的,因此当用户进入你的站点时,所有页面的 Page Meta 都会立即被加载。相比之下, Page Data 是存储在单独的文件中的,只有在用户进入对应页面时才会被加载。
616615

617-
因此,不建议在 Route Meta 中存储大量的信息,否则在站点有很多页面时,将会影响站点的初始加载速度。
616+
因此,不建议在 Page Meta 中存储大量的信息,否则在站点有很多页面时,将会影响站点的初始加载速度。
618617
:::
619618

620619
### sfcBlocks

docs/zh/reference/plugin-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ export default {
295295

296296
该 Hook 可以用来在 Page 对象上添加额外的属性,或修改现有的属性等。
297297

298-
值得一提的是,针对 `page.data``page.routeMeta` 的改动可以在客户端代码中使用。
298+
值得一提的是,针对 `page.data``page.meta` 的改动可以在客户端代码中使用。
299299

300300
- 示例:
301301

@@ -324,7 +324,7 @@ export default {
324324
- 参考:
325325
- [客户端 API > usePageData](./client-api.md#usepagedata)
326326
- [Node API > Page 属性 > data](./node-api.md#data)
327-
- [Node API > Page 属性 > routeMeta](./node-api.md#routemeta)
327+
- [Node API > Page 属性 > meta](./node-api.md#meta)
328328

329329
## 生命周期 Hooks
330330

0 commit comments

Comments
 (0)