编辑链接

编辑链接让你显示链接以编辑 Git 管理服务（如 GitHub 或 GitLab）上的页面。要启用它，请将 themeConfig.editLink 选项添加到你的配置中。

export default {
  themeConfig: {
    editLink: {
      pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path'
    }
  }
}

pattern 选项定义链接的 URL 结构，:path 将被页面路径替换。

你也可以接受一个函数来提供动态链接：

export default {
  themeConfig: {
    editLink: {
      pattern: ({ filePath }) => {
        if (filePath.startsWith('packages/')) {
          return `https://github.com/acme/monorepo/edit/main/${filePath}`
        } else {
          return `https://github.com/acme/monorepo/edit/main/docs/${filePath}`
        }
      }
    }
  }
}

它不应该有副作用，也不应该访问该函数外部的任何内容，因为它将被序列化并在浏览器中执行。

自定义文本

默认情况下，这将显示"Edit this page"，但你可以通过定义 text 选项来自定义此文本：

export default {
  themeConfig: {
    editLink: {
      pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path',
      text: 'Edit this page on GitHub'
    }
  }
}

Frontmatter 配置

可以使用 frontmatter 上的 editLink 选项在每个页面上禁用此功能：

---
editLink: false
---

类型定义

export interface EditLink {
  pattern: string | ((payload: EditLinkPattern) => string)
  text?: string
}

export interface EditLinkPattern {
  filePath: string
}