From c0e5c789a909f9ee5a4353f5df1aa9f6d8d12f6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?t=C9=99=C9=99na=2Evu=C9=99?= <76698025+franklin-tina@users.noreply.github.com> Date: Tue, 5 Mar 2024 19:51:47 -0600 Subject: [PATCH] docs: add documentation for using layers with private repos Update **Layers** documentation to include instructions for extending from private repositories. --- docs/1.getting-started/9.layers.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/1.getting-started/9.layers.md b/docs/1.getting-started/9.layers.md index ed61136af1af..5ef17a89cf9c 100644 --- a/docs/1.getting-started/9.layers.md +++ b/docs/1.getting-started/9.layers.md @@ -29,6 +29,18 @@ export default defineNuxtConfig({ }) ``` +The above example illustrates extending from a public GitHub repository. To extend from a **private** GitHub repository, follow the modified approach outlined below. + +```ts twoslash [nuxt.config.ts] +export default defineNuxtConfig({ + extends: [ + // per layer configuration + ['github:my-themes/private-awesome', { giget: { auth: process.env.GH_TOKEN } }] + ] +}) +``` + + ::read-more{to="/docs/guide/going-further/layers"} Read more about layers in the **Layer Author Guide**. ::