import{_ as i,c as a,ag as n,o as e}from"./chunks/framework.C1C4sYC0.js";const E=JSON.parse('{"title":"Editar Link","description":"","frontmatter":{},"headers":[],"relativePath":"pt/reference/default-theme-edit-link.md","filePath":"pt/reference/default-theme-edit-link.md","lastUpdated":1709796637000}'),t={name:"pt/reference/default-theme-edit-link.md"};function p(l,s,h,k,d,r){return e(),a("div",null,s[0]||(s[0]=[n(`
Editar Link permite que você mostre um link para editar a página com serviços de gerenciamento Git, como GitHub ou GitLab. Para habilitar, adicione a opção themeConfig.editLink na sua configuração.
export default {
themeConfig: {
editLink: {
pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path'
}
}
}A opção pattern define a estrutura da URL para o link, e :path será substituído com o mesmo caminho de página.
Você também pode colocar uma função pura que aceita PageData como argumento e retorna uma URL em string.
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}\`
}
}
}
}
}Isso não deve gerar efeitos colaterais ou acessar qualquer coisa fora do seu escopo, uma vez que será serializado e executado no navegador.
Por padrão, isso irá adicionar o link com texto "Edite essa página" no final da página de documentação. Você pode personalizar esse texto ao definir a opção text.
export default {
themeConfig: {
editLink: {
pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path',
text: 'Edite essa página no GitHub'
}
}
}A funcionalidade pode ser desabilitada por página usando a opção editLink no frontmatter:
---
editLink: false
---