编辑链接

源文件的链接.

编辑链接允许您在每页末尾显示一个链接, 以便在 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 选项允许你自定义链接文本 (默认是 编辑此页面)
  • icon 选项允许你自定义图标 (默认是 lucide:square-pen)
  • placement 选项控制放置编辑链接的位置.
    • docsFooter: 在页面底部.
    • toc: 在目录链接部分.

前言部分

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

---
editLink: false
---

参数

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