2.3 KiB
Ссылка для редактирования
Настройка в файле конфигурации
Ссылка на редактирование позволяет отобразить ссылку для редактирования страницы на сервисах управления Git, таких как GitHub или GitLab. Чтобы включить её, добавьте опции 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: 'Редактировать эту страницу на GitHub'
}
}
}
Настройка в метаданных
Эту ссылку можно отключить на конкретной странице с помощью опции editLink
в метаданных:
---
editLink: false
---