close

HomeHero eject-only

Warning

This component is an eject-only component, specifically designed for wrap/eject, and it's not recommended to be used directly in MDX files.

This component is part of the Home Page. HomeHero renders the hero section on the home page.

Usage

The HomeHero component reads the hero configuration from frontmatter via useFrontmatter. For detailed configuration options of hero, please refer to Frontmatter Config.

Custom slots

Use beforeHeroActions and afterHeroActions props to insert custom content before and after the action buttons:

index.mdx
import { HomeHero } from '@rspress/core/theme';

<HomeHero
  beforeHeroActions={<div>Content before buttons</div>}
  afterHeroActions={<div>Content after buttons</div>}
/>;

Props

beforeHeroActions

  • Type: React.ReactNode

Custom content to insert before the Hero buttons.

afterHeroActions

  • Type: React.ReactNode

Custom content to insert after the Hero buttons.