Edit Link
A link to the source file.
An edit link allows you to display a link at the end of each page to edit the page on GitHub / GitLab.
app.config.ts
- The
pattern
option defines the URL structure for the link, and:path
is going to be replaced with the page path. - The
text
option allows you to customize the link text (default isEdit this page
) - The
icon
option allows you to customize the icon (default islucide:square-pen
) - The
placement
option controls the places to put the edit link.docsFooter
: at the end of the page.toc
: in the TOC links section.
Front Matter
The edit link can be disabled per-page using the editLink
option in front matter.
Parameters
enableboolean
false
patternstring
textstring
Edit this page
iconstring
lucide:square-pen
placement('docsFooter' | 'toc')[]
['docsFooter']