🚧 Rspress 2.0 document is under development
close
Rspress
  • English

      • HomeFooter 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. HomeFooter renders footer information at the bottom of the home page.

      Usage

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

<HomeFooter />;

      This component does not accept any props. It automatically reads the footer.message content from the theme configuration.

      Configuration

      Configure footer information in rspress.config.ts:

      rspress.config.ts
      import { defineConfig } from '@rspress/core';

export default defineConfig({
  themeConfig: {
    footer: {
      message: 'Copyright © 2024 Your Company',
    },
  },
});

      How it works

      • The component reads footer content from themeConfig.footer.message
      • If message is not configured, the component will not render anything
      • message supports HTML strings