页面索引 (methanol:pages)
methanol:pages 虚拟模块提供了项目内所有页面的列表。利用该模块,你可以轻松构建博客归档、分类过滤器以及自定义搜索界面等客户端功能。
import pages from 'methanol:pages'
// 或
import { pages } from 'methanol:pages'
包含的内容
索引中的每个条目代表一个页面及其元数据。为了保持 Bundle 体积轻量,大型字段会被自动移除:
- 移除的字段:
content、mdxCtx以及getSiblings。 - 忽略的内容: 任何函数类型的字段。
- 始终包含:
excerpt(摘要)。若 Frontmatter 中未定义,Methanol 会自动从页面正文生成。 - 排除规则: 标记为
hidden: true的页面不会包含在索引中。
生成的对象包含 routePath、routeHref、title、frontmatter、stats 和 excerpt 等信息。
备注
- 此模块专为 客户端 逻辑设计。
- 在开发模式下,当页面发生变化时,索引内容会自动更新。