close

EditLink

EditLink отображает ссылку «Отредактировать страницу», которая ведёт на страницу редактирования исходного файла документа (например, на GitHub).

Использование

Этот компонент обычно отображается автоматически в составе DocFooter и не требует ручного использования.

import { EditLink as BasicEditLink } from '@rspress/core/theme-original';

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

Связанная конфигурация

Настройка editLink в 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: '📝 Редактировать эту страницу на GitHub',
    },
  },
});
  • docRepoBaseUrl — Базовый URL-адрес репозитория документации
  • text — Текст, отображаемый для ссылки

Если editLink не настроен, компонент ничего не отобразит.