close
Rspress
  • 中文

      • EditLink

      Warning

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

      EditLink 用于渲染"编辑此页"链接，点击后跳转到文档源文件的编辑页面（如 GitHub）。

      用法

      该组件会自动渲染在 DocFooter 和右侧大纲面板中，无需手动使用。

      编辑此页面
      import { EditLink as BasicEditLink } from '@rspress/core/theme-original';

export default function EditLink() {
  return <BasicEditLink />;
}

      Props

      属性类型默认值描述
      isOutlinebooleanfalse为 true 时，渲染带编辑图标的紧凑样式，用于大纲面板。为 false 时，渲染默认的文本链接样式，用于文档底部。

      相关配置

      在 rspress.config.ts 中配置 editLink：

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

export default defineConfig({
  themeConfig: {
    editLink: {
      docRepoBaseUrl:
        'https://github.com/web-infra-dev/rspress/tree/main/website/docs',
      text: '📝 在 GitHub 上编辑此页',
    },
  },
});
      • docRepoBaseUrl - 文档仓库的基础 URL
      • text - 链接显示的文本

      如果未配置 editLink，组件不会渲染任何内容。