Ссылка для Редактирования
Конфигурация на Уровне Сайта
Ссылка для редактирования позволяет отображать ссылку на редактирование страницы на сервисах управления 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'
}
}
}
Конфигурация Frontmatter
Это можно отключить для каждой страницы, используя опцию editLink
в frontmatter:
---
editLink: false
---