nuxt / nuxt/icon

is collections entry correct at readme file?

Open
#443 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.2k
Forks
96
Avg merge
8h 12m
Merged PRs (30d)
2

Description

This configuration seems to be wrong, we need collections as direct icon child (testing tresjs apps/lab when migrating to tsdown) all json collections in the nuxt server.mjs):

export default defineNuxtConfig({
  modules: ['@nuxt/icon'],
  icon: {
    collections: ['uil', 'mdi'] // <== SHOULD BE HERE?
    serverBundle: {
      collections: ['uil', 'mdi'] // <== IS THIS FINE?
    }
  }
})

including collections inside serverBundle
collections inside serverBundle

including collections as direct child
collections as direct icon child

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README configuration example and compare the two shown locations for the collections option in the Nuxt Icon config. Confirm the supported nesting and update the README so the example reflects the correct configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
nuxtjs, typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.