编辑链接

站点级配置

编辑链接允许您显示一个链接，用于在 GitHub 或 GitLab 等 Git 管理服务上编辑页面。要启用它，请将 themeConfig.editLink 选项添加到您的配置中。

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

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

您也可以使用一个纯函数，该函数接受 PageData 作为参数并返回 URL 字符串。

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}`
        }
      }
    }
  }
}

它不应该有副作用，也不应该访问其范围之外的任何内容，因为它将在浏览器中被序列化和执行。

默认情况下，这将在文档页面的底部添加“编辑此页面”链接文本。您可以通过定义 text 选项来自定义此文本。

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

前置信息配置

可以使用前置信息中的 editLink 选项禁用每个页面。

---
editLink: false
---