close
Rspress
  • English

      • DocFooter

      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.

      DocFooter renders the footer area at the bottom of doc pages, including the edit link, last updated time, and prev/next page navigation.

      Usage

      This component is automatically rendered at the bottom of doc pages and usually does not need to be used manually. To customize it, eject the component:

      import { DocFooter as BasicDocFooter } from '@rspress/core/theme-original';

export default function DocFooter() {
  return <BasicDocFooter />;
}
      theme/components/DocFooter/index.tsx
      import { EditLink, LastUpdated, PrevNextPage } from '@rspress/core/theme';
import './index.scss';

export function DocFooter() {
  return (
    <footer className="rp-doc-footer">
      <div className="rp-doc-footer__edit">
        <EditLink />
        <LastUpdated />
      </div>
      <div className="rp-doc-footer__divider" />
      <PrevNextPage />
    </footer>
  );
}

      Included components

      DocFooter consists of the following components: