Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add documentation for using layers with private repos #26094

Merged
merged 4 commits into from Mar 6, 2024
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/1.getting-started/9.layers.md
Expand Up @@ -29,6 +29,19 @@ export default defineNuxtConfig({
})
```

You can also pass an authentication token if you are extending from a private GitHub repository:

```ts twoslash [nuxt.config.ts]
export default defineNuxtConfig({
extends: [
// per layer configuration
['github:my-themes/private-awesome', { giget: { auth: process.env.GH_TOKEN } }]
pi0 marked this conversation as resolved.
Show resolved Hide resolved
danielroe marked this conversation as resolved.
Show resolved Hide resolved
]
})
```

This uses [giget](https://unjs.io/packages/giget) under the hood for authenticating access to private repositories. For more information about this, visit [the documentation](https://unjs.io/packages/giget#providing-token-for-private-repositories) on "Providing token for private repositories"
danielroe marked this conversation as resolved.
Show resolved Hide resolved
danielroe marked this conversation as resolved.
Show resolved Hide resolved

::read-more{to="/docs/guide/going-further/layers"}
Read more about layers in the **Layer Author Guide**.
::
Expand Down