close
Rspress
  • English

      • Homepage

      Rspress provides a homepage layout out of the box. Set pageType: home in frontmatter to quickly generate a usable site homepage.

      Define homepage content through frontmatter. See Frontmatter Config for the full types. Here is a simple example:

      docs/index.mdx
      ---
pageType: home
title: Rspress
titleSuffix: 'Rsbuild-based Static Site Generator'

hero:
  name: Rspress
  text: A documentation solution
  tagline: A modern documentation development technology stack
  actions:
    - theme: brand
      text: Introduction
      link: /en/guide/introduction
    - theme: alt
      text: Quick Start
      link: /en/guide/getting-started

features:
  - title: 'MDX Support'
    details: MDX is a powerful way to write content. You can use React components in Markdown.
    icon: 📦
  - title: 'Feature Rich'
    details: Out-of-the-box support for i18n, full-text search, and more.
    icon: 🎨
  - title: 'Customizable'
    details: Customize the theme UI and build process.
    icon: 🚀
---

      Home components

      The Rspress homepage consists of these components, which you can customize through Custom Theme - ESM Re-export:

      Tip

      You can also customize the entire homepage by overriding the HomeLayout component. If you do this, homepage-related configuration and these frontmatter fields will no longer take effect.

      Configuration details

      For complete homepage frontmatter options, see Frontmatter Config.