编辑链接

指向源文件的链接。

编辑链接允许您在每个页面的末尾显示一个链接,用于在 GitHub / GitLab 上编辑页面。

app.config.ts
export default defineAppConfig({
  shadcnDocs: {
    main: {
      editLink: {
        enable: true,
        pattern: 'https://github.com/ZTL-UwU/shadcn-docs-nuxt/edit/main/content/:path',
        text: 'Edit this page on GitHub',
        icon: 'lucide:square-pen',
        placement: ['docsFooter', 'toc'],
      },
    }
  },
});
  • pattern 选项定义链接的 URL 结构,:path 将被替换为页面路径。
  • text 选项允许您自定义链接文本(默认为 Edit this page
  • icon 选项允许您自定义图标(默认为 lucide:square-pen
  • placement 选项控制编辑链接的放置位置。
    • docsFooter:在页面末尾。
    • toc:在目录链接部分。

Front Matter

可以使用 front matter 中的 editLink 选项在每个页面上禁用编辑链接。

---
editLink: false
---

参数

enableboolean
false
是否启用编辑链接。
patternstring
链接模式。
textstring
Edit this page
链接上显示的文本。
iconstring
lucide:square-pen
链接前的图标。
placement('docsFooter' | 'toc')[]
['docsFooter']
编辑链接的放置位置。