Edit Link

The edit link shows an “Edit” entry on documentation pages so authors can jump directly to the source file.

This is a build-time feature configured by server.editLink in vp/config/runtime.ts. During build, vanilla-press generates a link from the current page path and writes it to HTML.

Configuration

server.editLink is enabled by default.

TypeScript
export default {  server: {    editLink: true,  },}

• false disables the edit link.
• true uses the default config:

TypeScript
export default {  server: {    editLink: {      pattern:        'https://github.com/WangShai123/vanilla-press/edit/main/docs/:path',      text: 'editor.editLink',    },  },}

pattern

pattern is the edit link template and supports the :path placeholder.

During build, :path is replaced with the Markdown source path for the current page:

Conversion rules:

• The .html suffix becomes .md.
• A leading / is removed.
• Each path segment is URL-encoded.

For example, point the link to your own GitHub repository:

TypeScript
export default {  server: {    editLink: {      pattern: 'https://github.com/your-name/your-repo/edit/main/docs/:path',    },  },}

text

text controls the link label.

The default value is editor.editLink, which is resolved through the current locale in vp/config/languages.ts.

TypeScript
export default {  server: {    editLink: {      text: 'editor.editLink',    },  },}

Default multilingual config:

TypeScript
export default {  'zh-CN': {    editor: {      editLink: '在 GitHub 上编辑此页面',    },  },  en: {    editor: {      editLink: 'Edit this page on GitHub',    },  },}

Output

When enabled, HTML is generated and emitted.