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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 4 commits into from Mar 6, 2024
Merged

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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c0e5c78
docs: add documentation for using layers with private repos
franklin-tina Mar 6, 2024
07a0b99
Update 9.layers.md
franklin-tina Mar 6, 2024
25950e2
chore: slight tweak
danielroe Mar 6, 2024
64f08cf
docs: fixes
danielroe Mar 6, 2024
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
View file
Open in desktop
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', { auth: process.env.GITHUB_TOKEN }]
]
})
```

Nuxt uses [unjs/c12](https://c12.unjs.io) and [unjs/giget](https://giget.unjs.io) for extending remote layers. Check the documentation for more information and all available options.

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