docs(description): add description frontmatter to ui documentation files (#3008)

SoonIter · web-flow · commit 38a630e23f2b · 2026-01-19T13:24:18.000+08:00
diff --git a/website/docs/en/ui/components/badge.mdx b/website/docs/en/ui/components/badge.mdx
@@ -1,4 +1,5 @@
 ---
+description: Badge component for displaying small inline labels in documentation, with support for multiple types and styles.
 overviewHeaders: []
 ---
 
diff --git a/website/docs/en/ui/components/banner.mdx b/website/docs/en/ui/components/banner.mdx
@@ -1,4 +1,5 @@
 ---
+description: Banner notification component for displaying messages at the top of the page, with link navigation and close functionality.
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/en/ui/components/callout.mdx b/website/docs/en/ui/components/callout.mdx
@@ -1,4 +1,5 @@
 ---
+description: Callout component for displaying highlighted information blocks such as tips, warnings, and notes.
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/en/ui/components/code-block-runtime.mdx b/website/docs/en/ui/components/code-block-runtime.mdx
@@ -1,4 +1,5 @@
 ---
+description: CodeBlockRuntime component for dynamically rendering executable code blocks at runtime.
 overviewHeaders: []
 tag: non-ejectable
 ---
diff --git a/website/docs/en/ui/components/doc-footer.mdx b/website/docs/en/ui/components/doc-footer.mdx
@@ -1,4 +1,5 @@
 ---
+description: DocFooter component including edit link, last updated time, and previous/next page navigation.
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/en/ui/components/edit-link.mdx b/website/docs/en/ui/components/edit-link.mdx
@@ -1,4 +1,5 @@
 ---
+description: EditLink component for rendering an "Edit this page" link that navigates to the document source file edit page.
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/en/ui/components/home-background.mdx b/website/docs/en/ui/components/home-background.mdx
@@ -1,4 +1,5 @@
 ---
+description: HomeBackground component for rendering background effects on the homepage and automatically setting transparent navbar.
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/en/ui/components/home-feature.mdx b/website/docs/en/ui/components/home-feature.mdx
@@ -1,4 +1,5 @@
 ---
+description: HomeFeature component for rendering feature grid cards below the Hero section on the homepage.
 overviewHeaders: []
 tag: eject-only
 features:
diff --git a/website/docs/en/ui/components/home-footer.mdx b/website/docs/en/ui/components/home-footer.mdx
@@ -1,4 +1,5 @@
 ---
+description: HomeFooter component for rendering footer information at the bottom of the homepage.
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/en/ui/components/home-hero.mdx b/website/docs/en/ui/components/home-hero.mdx
@@ -1,4 +1,5 @@
 ---
+description: HomeHero component for rendering the Hero section on the homepage, including title, description, and action buttons.
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/en/ui/components/index.mdx b/website/docs/en/ui/components/index.mdx
@@ -1,4 +1,5 @@
 ---
+description: Overview of Rspress built-in components, including commonly used UI components for documentation.
 overviewHeaders: []
 overview: true
 title: Built-in components
diff --git a/website/docs/en/ui/components/last-updated.mdx b/website/docs/en/ui/components/last-updated.mdx
@@ -1,4 +1,5 @@
 ---
+description: LastUpdated component for displaying the last update time of a page.
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/en/ui/components/overview-group.mdx b/website/docs/en/ui/components/overview-group.mdx
@@ -1,4 +1,5 @@
 ---
+description: OverviewGroup component for rendering grouped cards and page lists on overview pages.
 overviewHeaders: []
 ---
 
diff --git a/website/docs/en/ui/components/package-manager-tabs.mdx b/website/docs/en/ui/components/package-manager-tabs.mdx
@@ -1,4 +1,5 @@
 ---
+description: PackageManagerTabs component for displaying installation commands across different package managers.
 overviewHeaders: []
 ---
 
diff --git a/website/docs/en/ui/components/page-tabs.mdx b/website/docs/en/ui/components/page-tabs.mdx
@@ -1,4 +1,5 @@
 ---
+description: PageTabs component for creating multiple sub-tabs within a single page.
 tag: experimental
 overviewHeaders: []
 ---
diff --git a/website/docs/en/ui/components/prev-next-page.mdx b/website/docs/en/ui/components/prev-next-page.mdx
@@ -1,4 +1,5 @@
 ---
+description: PrevNextPage component for rendering previous/next page navigation links at the page bottom.
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/en/ui/components/root.mdx b/website/docs/en/ui/components/root.mdx
@@ -1,4 +1,5 @@
 ---
+description: Root component serving as the wrapper for the entire application, used to wrap custom Providers.
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/en/ui/components/source-code.mdx b/website/docs/en/ui/components/source-code.mdx
@@ -1,4 +1,5 @@
 ---
+description: SourceCode component for rendering links to GitHub or GitLab repository source code.
 overviewHeaders: []
 ---
 
diff --git a/website/docs/en/ui/components/steps.mdx b/website/docs/en/ui/components/steps.mdx
@@ -1,4 +1,5 @@
 ---
+description: Steps component for rendering Markdown content as step-by-step instruction blocks.
 overviewHeaders: []
 ---
 
diff --git a/website/docs/en/ui/components/tabs.mdx b/website/docs/en/ui/components/tabs.mdx
@@ -1,4 +1,5 @@
 ---
+description: Tabs component for switching between multiple content panels, with group synchronization support.
 overviewHeaders: []
 ---
 
diff --git a/website/docs/en/ui/components/tag.mdx b/website/docs/en/ui/components/tag.mdx
@@ -1,4 +1,5 @@
 ---
+description: Tag component for displaying labels in the sidebar or navbar, supporting built-in tags, SVG, and images.
 tag: new, eject-only
 overviewHeaders: []
 ---
diff --git a/website/docs/en/ui/custom-page.mdx b/website/docs/en/ui/custom-page.mdx
@@ -1,3 +1,7 @@
+---
+description: Methods for customizing page layout, global components, styles, and head tags.
+---
+
 import { PackageManagerTabs } from '@theme';
 
 # Customizing page
diff --git a/website/docs/en/ui/hooks/index.mdx b/website/docs/en/ui/hooks/index.mdx
@@ -1,4 +1,5 @@
 ---
+description: Overview of Rspress built-in React hooks for accessing page data, theme state, and routing information.
 overview: true
 title: Built-in hooks
 ---
diff --git a/website/docs/en/ui/hooks/router-hooks.mdx b/website/docs/en/ui/hooks/router-hooks.mdx
@@ -1,3 +1,7 @@
+---
+description: Router hooks re-exported from react-router-dom for accessing navigation and location information.
+---
+
 # Router hooks
 
 Rspress re-exports the routing utilities from `react-router-dom`, letting you access navigation and location data without adding extra dependencies.
diff --git a/website/docs/en/ui/hooks/use-dark.mdx b/website/docs/en/ui/hooks/use-dark.mdx
@@ -1,3 +1,7 @@
+---
+description: useDark hook for determining whether the current theme is dark mode.
+---
+
 # useDark
 
 `useDark` reports whether the current theme is dark mode.
diff --git a/website/docs/en/ui/hooks/use-frontmatter.mdx b/website/docs/en/ui/hooks/use-frontmatter.mdx
@@ -1,3 +1,7 @@
+---
+description: useFrontmatter hook for accessing the current page's frontmatter metadata.
+---
+
 # useFrontmatter
 
 `useFrontmatter` returns the [frontmatter](/api/config/config-frontmatter) of the current page in a convenient object.
diff --git a/website/docs/en/ui/hooks/use-i18n.mdx b/website/docs/en/ui/hooks/use-i18n.mdx
@@ -1,3 +1,7 @@
+---
+description: useI18n hook for reading configured multilingual text in custom components.
+---
+
 # useI18n
 
 `useI18n` lets you read localized text inside custom components using the configured source. For setup details, see [config.i18nSource](../../api/config/config-basic.mdx#i18nsource).
diff --git a/website/docs/en/ui/hooks/use-lang.mdx b/website/docs/en/ui/hooks/use-lang.mdx
@@ -1,3 +1,7 @@
+---
+description: useLang hook for getting the current language code for multilingual rendering and route navigation.
+---
+
 # useLang
 
 `useLang` returns the current locale code so you can render language-specific content or route users accordingly.
diff --git a/website/docs/en/ui/hooks/use-page-data.mdx b/website/docs/en/ui/hooks/use-page-data.mdx
@@ -1,4 +1,5 @@
 ---
+description: usePageData hook (deprecated) for accessing current page metadata, use usePage instead.
 tag: deprecated
 ---
 
diff --git a/website/docs/en/ui/hooks/use-page.mdx b/website/docs/en/ui/hooks/use-page.mdx
@@ -1,3 +1,7 @@
+---
+description: usePage hook for accessing metadata of the current Markdown/MDX page.
+---
+
 # usePage
 
 `usePage` exposes metadata extracted from the current Markdown or MDX page.
diff --git a/website/docs/en/ui/hooks/use-pages.mdx b/website/docs/en/ui/hooks/use-pages.mdx
@@ -1,3 +1,7 @@
+---
+description: usePages hook for accessing metadata of all pages in the site.
+---
+
 # usePages
 
 `usePages` returns metadata for all pages in the site and is handy for building custom [overview pages](/guide/advanced/overview-page) such as a blog index.
diff --git a/website/docs/en/ui/hooks/use-site.mdx b/website/docs/en/ui/hooks/use-site.mdx
@@ -1,3 +1,7 @@
+---
+description: useSite hook for accessing the normalized site configuration from rspress.config.ts.
+---
+
 # useSite
 
 `useSite` returns the normalized site configuration generated from your `rspress.config.ts`.
diff --git a/website/docs/en/ui/hooks/use-version.mdx b/website/docs/en/ui/hooks/use-version.mdx
@@ -1,3 +1,7 @@
+---
+description: useVersion hook for getting the current documentation version in multi-version docs.
+---
+
 # useVersion
 
 `useVersion` provides the current documentation version when multi-version docs are enabled.
diff --git a/website/docs/en/ui/icons/index.mdx b/website/docs/en/ui/icons/index.mdx
@@ -1,3 +1,7 @@
+---
+description: List of Rspress built-in icons and how to replace them via custom theme.
+---
+
 # Built-in icons
 
 import { SvgWrapper, SourceCode } from '@rspress/core/theme';
diff --git a/website/docs/en/ui/runtime-components/head.mdx b/website/docs/en/ui/runtime-components/head.mdx
@@ -1,4 +1,5 @@
 ---
+description: Head component for injecting custom head content into document pages, such as meta tags and links.
 overviewHeaders: []
 ---
 
diff --git a/website/docs/en/ui/runtime-components/index.mdx b/website/docs/en/ui/runtime-components/index.mdx
@@ -1,4 +1,5 @@
 ---
+description: Overview of Rspress runtime components, including Head and NoSSR for runtime use.
 title: Runtime components
 overview: true
 ---
diff --git a/website/docs/en/ui/runtime-components/no-ssr.mdx b/website/docs/en/ui/runtime-components/no-ssr.mdx
@@ -1,4 +1,5 @@
 ---
+description: NoSSR component for disabling server-side rendering and rendering content only on the client.
 overviewHeaders: []
 ---
 
diff --git a/website/docs/en/ui/vars.mdx b/website/docs/en/ui/vars.mdx
@@ -1,3 +1,7 @@
+---
+description: List of Rspress built-in CSS variables for customizing brand colors, code block styles, and theme configuration.
+---
+
 # CSS variables
 
 Rspress exposes commonly used CSS variables. Overriding variables is simpler and more maintainable than replacing the built-in React components.
diff --git a/website/docs/zh/ui/components/badge.mdx b/website/docs/zh/ui/components/badge.mdx
@@ -1,4 +1,5 @@
 ---
+description: Badge 徽章组件，用于在文档中显示小型内联标记，支持多种类型和样式。
 overviewHeaders: []
 ---
 
diff --git a/website/docs/zh/ui/components/banner.mdx b/website/docs/zh/ui/components/banner.mdx
@@ -1,4 +1,5 @@
 ---
+description: Banner 通知横幅组件，用于在页面顶部显示通知消息，支持链接跳转和关闭功能。
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/zh/ui/components/callout.mdx b/website/docs/zh/ui/components/callout.mdx
@@ -1,4 +1,5 @@
 ---
+description: Callout 提示框组件，用于显示高亮的信息块，如提示、警告和注意事项。
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/zh/ui/components/code-block-runtime.mdx b/website/docs/zh/ui/components/code-block-runtime.mdx
@@ -1,4 +1,5 @@
 ---
+description: CodeBlockRuntime 运行时代码块组件，用于动态渲染可执行的代码块。
 overviewHeaders: []
 tag: non-ejectable
 ---
diff --git a/website/docs/zh/ui/components/doc-footer.mdx b/website/docs/zh/ui/components/doc-footer.mdx
@@ -1,4 +1,5 @@
 ---
+description: DocFooter 文档页脚组件，包含编辑链接、最后更新时间和上一页/下一页导航。
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/zh/ui/components/edit-link.mdx b/website/docs/zh/ui/components/edit-link.mdx
@@ -1,4 +1,5 @@
 ---
+description: EditLink 编辑链接组件，用于渲染"编辑此页"链接，跳转到文档源文件编辑页面。
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/zh/ui/components/home-background.mdx b/website/docs/zh/ui/components/home-background.mdx
@@ -1,4 +1,5 @@
 ---
+description: HomeBackground 首页背景组件，用于渲染首页背景效果并自动设置透明导航栏。
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/zh/ui/components/home-feature.mdx b/website/docs/zh/ui/components/home-feature.mdx
@@ -1,4 +1,5 @@
 ---
+description: HomeFeature 首页特性组件，用于在首页 Hero 区域下方渲染特性网格卡片。
 overviewHeaders: []
 tag: eject-only
 features:
diff --git a/website/docs/zh/ui/components/home-footer.mdx b/website/docs/zh/ui/components/home-footer.mdx
@@ -1,4 +1,5 @@
 ---
+description: HomeFooter 首页页脚组件，用于在首页底部渲染页脚信息。
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/zh/ui/components/home-hero.mdx b/website/docs/zh/ui/components/home-hero.mdx
@@ -1,4 +1,5 @@
 ---
+description: HomeHero 首页主视觉组件，用于渲染首页的 Hero 区域，包含标题、描述和操作按钮。
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/zh/ui/components/index.mdx b/website/docs/zh/ui/components/index.mdx
@@ -1,4 +1,5 @@
 ---
+description: Rspress 内置组件概览，包含文档编写常用的 UI 组件。
 overviewHeaders: []
 overview: true
 title: 内置组件
diff --git a/website/docs/zh/ui/components/last-updated.mdx b/website/docs/zh/ui/components/last-updated.mdx
@@ -1,4 +1,5 @@
 ---
+description: LastUpdated 最后更新时间组件，用于展示页面的最后更新时间。
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/zh/ui/components/overview-group.mdx b/website/docs/zh/ui/components/overview-group.mdx
@@ -1,4 +1,5 @@
 ---
+description: OverviewGroup 概览分组组件，用于渲染概览页面中的分组卡片和页面列表。
 overviewHeaders: []
 ---
 
diff --git a/website/docs/zh/ui/components/package-manager-tabs.mdx b/website/docs/zh/ui/components/package-manager-tabs.mdx
@@ -1,4 +1,5 @@
 ---
+description: PackageManagerTabs 包管理器标签组件，用于展示不同包管理器的安装命令。
 overviewHeaders: []
 ---
 
diff --git a/website/docs/zh/ui/components/page-tabs.mdx b/website/docs/zh/ui/components/page-tabs.mdx
@@ -1,4 +1,5 @@
 ---
+description: PageTabs 页面标签组件，用于在同一页面中创建多个子标签页。
 tag: experimental
 overviewHeaders: []
 ---
diff --git a/website/docs/zh/ui/components/prev-next-page.mdx b/website/docs/zh/ui/components/prev-next-page.mdx
@@ -1,4 +1,5 @@
 ---
+description: PrevNextPage 上下页导航组件，用于渲染页面底部的上一页/下一页链接。
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/zh/ui/components/root.mdx b/website/docs/zh/ui/components/root.mdx
@@ -1,4 +1,5 @@
 ---
+description: Root 根组件，作为整个应用的包装组件，用于包裹自定义 Provider。
 overviewHeaders: []
 tag: eject-only
 ---
diff --git a/website/docs/zh/ui/components/source-code.mdx b/website/docs/zh/ui/components/source-code.mdx
@@ -1,4 +1,5 @@
 ---
+description: SourceCode 源码链接组件，用于渲染指向 GitHub 或 GitLab 仓库源码的链接。
 overviewHeaders: []
 ---
 
diff --git a/website/docs/zh/ui/components/steps.mdx b/website/docs/zh/ui/components/steps.mdx
@@ -1,4 +1,5 @@
 ---
+description: Steps 步骤组件，用于将 Markdown 内容渲染为分步说明块。
 overviewHeaders: []
 ---
 
diff --git a/website/docs/zh/ui/components/tabs.mdx b/website/docs/zh/ui/components/tabs.mdx
@@ -1,4 +1,5 @@
 ---
+description: Tabs 标签页组件，用于在多个内容面板间切换，支持分组同步。
 overviewHeaders: []
 ---
 
diff --git a/website/docs/zh/ui/components/tag.mdx b/website/docs/zh/ui/components/tag.mdx
@@ -1,4 +1,5 @@
 ---
+description: Tag 标签组件，用于在侧边栏或导航栏中显示标记，支持内置标签、SVG 和图片。
 tag: new, eject-only
 overviewHeaders: []
 ---
diff --git a/website/docs/zh/ui/custom-page.mdx b/website/docs/zh/ui/custom-page.mdx
@@ -1,3 +1,7 @@
+---
+description: 自定义页面布局、全局组件、样式和 head 标签等页面定制方法。
+---
+
 import { PackageManagerTabs } from '@theme';
 
 # 自定义页面
diff --git a/website/docs/zh/ui/hooks/index.mdx b/website/docs/zh/ui/hooks/index.mdx
@@ -1,4 +1,5 @@
 ---
+description: Rspress 内置 React hooks 概览，用于获取页面数据、主题状态和路由信息。
 overview: true
 title: 内置 hooks
 ---
diff --git a/website/docs/zh/ui/hooks/router-hooks.mdx b/website/docs/zh/ui/hooks/router-hooks.mdx
@@ -1,3 +1,7 @@
+---
+description: 路由相关 hooks，重导出自 react-router-dom，用于访问导航与位置信息。
+---
+
 # 路由 Hooks
 
 Rspress 直接重导出 `react-router-dom` 的路由能力，你可以无需额外依赖就访问导航与位置信息。
diff --git a/website/docs/zh/ui/hooks/use-dark.mdx b/website/docs/zh/ui/hooks/use-dark.mdx
diff --git a/website/docs/zh/ui/hooks/use-frontmatter.mdx b/website/docs/zh/ui/hooks/use-frontmatter.mdx
diff --git a/website/docs/zh/ui/hooks/use-i18n.mdx b/website/docs/zh/ui/hooks/use-i18n.mdx
diff --git a/website/docs/zh/ui/hooks/use-lang.mdx b/website/docs/zh/ui/hooks/use-lang.mdx
diff --git a/website/docs/zh/ui/hooks/use-page-data.mdx b/website/docs/zh/ui/hooks/use-page-data.mdx
diff --git a/website/docs/zh/ui/hooks/use-page.mdx b/website/docs/zh/ui/hooks/use-page.mdx
diff --git a/website/docs/zh/ui/hooks/use-pages.mdx b/website/docs/zh/ui/hooks/use-pages.mdx
diff --git a/website/docs/zh/ui/hooks/use-site.mdx b/website/docs/zh/ui/hooks/use-site.mdx
diff --git a/website/docs/zh/ui/hooks/use-version.mdx b/website/docs/zh/ui/hooks/use-version.mdx
diff --git a/website/docs/zh/ui/icons/index.mdx b/website/docs/zh/ui/icons/index.mdx
diff --git a/website/docs/zh/ui/runtime-components/head.mdx b/website/docs/zh/ui/runtime-components/head.mdx
diff --git a/website/docs/zh/ui/runtime-components/index.mdx b/website/docs/zh/ui/runtime-components/index.mdx
diff --git a/website/docs/zh/ui/runtime-components/no-ssr.mdx b/website/docs/zh/ui/runtime-components/no-ssr.mdx
diff --git a/website/docs/zh/ui/vars.mdx b/website/docs/zh/ui/vars.mdx
