From f3d81ef7d6b660efbd331b2b1fb8f7ec9c6bbe34 Mon Sep 17 00:00:00 2001 From: Dominic Marcelino <46492597+Dominic-Marcelino@users.noreply.github.com> Date: Thu, 18 Jan 2024 16:33:22 +0100 Subject: [PATCH] docs: explain how to auto-install git layer deps (#24250) Co-authored-by: Daniel Roe --- docs/2.guide/3.going-further/7.layers.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/2.guide/3.going-further/7.layers.md b/docs/2.guide/3.going-further/7.layers.md index 4d5f85a078..a137ef229d 100644 --- a/docs/2.guide/3.going-further/7.layers.md +++ b/docs/2.guide/3.going-further/7.layers.md @@ -98,8 +98,16 @@ export default defineNuxtConfig({ If you want to extend a private remote source, you need to add the environment variable `GIGET_AUTH=` to provide a token. :: -::callout{color="amber" icon="i-ph-warning-duotone"} -Currently, with git remote sources, if a layer has npm dependencies, you will need to manually install them in the target project. We are working on this to auto-install layer dependencies with git sources. +::callout{color="blue" icon="i-ph-info-duotone"} +When using git remote sources, if a layer has npm dependencies and you wish to install them, you can do so by specifying `install: true` in your layer options. + +```ts [nuxt.config.ts] +export default defineNuxtConfig({ + extends: [ + ['github:username/repoName', { install: true }] + ] +}) +``` :: ### npm Package