mirror of https://github.com/vuejs/vitepress
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
29 lines
781 B
29 lines
781 B
3 years ago
|
# Edit Link
|
||
|
|
|
||
3 years ago
|
Edit Link lets you display a link to edit the page on Git management services such as GitHub, or GitLab. To enable it, add `themeConfig.editLink` options to your config.
|
||
|
|
|
||
|
|
```js
|
||
|
|
export default {
|
||
|
|
themeConfig: {
|
||
|
|
editLink: {
|
||
|
|
pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path'
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
The `pattern` option defines the URL structure for the link, and `:path` is going to be replaced with the page path.
|
||
|
|
|
||
|
|
By default, this will add the link text "Edit this page" at the bottom of the doc page. You may customize this text by defining the `text` option.
|
||
|
|
|
||
|
|
```js
|
||
|
|
export default {
|
||
|
|
themeConfig: {
|
||
|
|
editLink: {
|
||
|
|
pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path',
|
||
|
|
text: 'Edit this page on GitHub'
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|