Skip to content

docs(README): document extendable layer setup for Nuxt projects #448

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

Open
mkucmus wants to merge 2 commits into
base: main
Choose a base branch
from
+8 −1
Open

docs(README): document extendable layer setup for Nuxt projects #448

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b226b2
docs(README): document extendable layer setup for Nuxt projects
mkucmus Dec 5, 2025
697e62c
fix: apply suggestion from CR
mkucmus Dec 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,10 @@ assets/my-icons
In your `nuxt.config.ts`, add an item in `icon.customCollections`:

```ts
import { createResolver } from "@nuxt/kit"

const { resolve } = createResolver(import.meta.url)

export default defineNuxtConfig({
modules: [
'@nuxt/icon'
Expand All @@ -165,7 +169,7 @@ export default defineNuxtConfig({
customCollections: [
{
prefix: 'my-icon',
dir: './assets/my-icons',
dir: resolve('./assets/my-icons'),
// if you want to include all the icons in nested directories:
// recursive: true,
},
Expand All @@ -174,6 +178,9 @@ export default defineNuxtConfig({
})
```

> [!NOTE]
> We use `createResolver` and `resolve()` to ensure paths work correctly both in regular projects and when your project is used as an extendable layer by other Nuxt projects. This ensures icon paths resolve relative to your project's directory rather than the consuming project's directory.

> [!NOTE]
> If you are running on Nuxt 4 with the new `app` directory, the assets directory is `'./app/assets/*'` instead of `'./assets/*'`.

Expand Down