リンクを編集する

サイトレベル設定

リンクを編集するページに、GitHubやGitLabなどのGit管理サービスでページを編集するためのリンクを表示できます。有効にするには、 configに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
---