close
Rspress
  • English

      • EditLink

      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.

      EditLink renders an "Edit this page" link that navigates to the document source file's editing page (e.g., GitHub).

      Usage

      This component is usually rendered automatically as part of DocFooter and doesn't need manual usage.

      Configure editLink in rspress.config.ts:

      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: '📝 Edit this page on GitHub',
    },
  },
});
      • docRepoBaseUrl - Base URL of the documentation repository
      • text - Text displayed on the link

      If editLink is not configured, the component won't render anything.