Lien d'Édition

Un lien vers le fichier source.

Un lien d'édition vous permet d'afficher un lien à la fin de chaque page pour éditer la page sur 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: 'Modifier cette page sur GitHub',
        icon: 'lucide:square-pen',
        placement: ['docsFooter', 'toc'],
      },
    }
  },
});
  • L'option pattern définit la structure de l'URL pour le lien, et :path sera remplacé par le chemin de la page.
  • L'option text vous permet de personnaliser le texte du lien (par défaut est Modifier cette page)
  • L'option icon vous permet de personnaliser l'icône (par défaut est lucide:square-pen)
  • L'option placement contrôle les endroits où placer le lien d'édition.
    • docsFooter : à la fin de la page.
    • toc : dans la section des liens de la table des matières.

Front Matter

Le lien d'édition peut être désactivé par page en utilisant l'option editLink dans le front matter.

---
editLink: false
---

Paramètres

enableboolean
false
Si le lien d'édition doit être activé.
patternstring
Le modèle de lien.
textstring
Modifier cette page
Texte affiché sur le lien.
iconstring
lucide:square-pen
L'icône précédant le lien.
placement('docsFooter' | 'toc')[]
['docsFooter']
Où placer le lien d'édition.