close
Rspress
  • English

      • HomeFeature

      Warning

      This component is mainly used in conjunction with wrap/eject in Custom Theme , and is different from components that are directly imported in MDX. You can modify the styles and functions by passing component props or directly overriding the component. If you override the entire component through eject, please note that the reading of the corresponding configuration options of the component will become invalid and you need to control it yourself.

      This component is part of the homepage. HomeFeature renders a feature grid below the Hero section on the homepage.

      Usage

      Modify or override through custom theme.

      You can configure features in the frontmatter of your mdx file, and the component will automatically read it through useFrontmatter. For detailed configuration options, refer to Frontmatter Configuration.

      Props

      features

      • Type: Feature[]
      • Default: Read from frontmatter
      interface Feature {
  /** Feature icon, supports emoji or HTML string */
  icon: string;
  /** Feature title */
  title: string;
  /** Feature description, supports HTML string */
  details: string;
  /** Grid column span, supports 2, 3, 4, 6, defaults to 4 */
  span?: 2 | 3 | 4 | 6;
  /** Link to navigate when clicking the card */
  link?: string;
}
      • span controls how many grid columns each card occupies, total 12 columns
      • icon and details support HTML strings
      • Setting link makes the card clickable for navigation