close
Rspress
  • 中文

      • DocFooter

      Warning

      该组件主要配合 自定义主题 中的 wrap/eject 使用 ，与 MDX 里直接导入使用的组件不同，你可以通过传递组件 props 或直接覆盖该组件达到修改样式和功能的目的。如果通过 eject 覆盖整个组件，需注意组件对应配置项的读取会失效，需要自行控制。

      DocFooter 用于渲染文档页面底部的页脚区域，包含编辑链接、最后更新时间和上一页/下一页导航。

      用法

      该组件会在文档页面底部自动渲染，通常不需要手动使用。如需自定义，可通过 eject 修改：

      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>
  );
}

      包含的组件

      DocFooter 由以下组件组成：