framework icon indicating copy to clipboard operation
framework copied to clipboard

docs(components): Add info about `extensions` and `pathPrefix` keys

Open MorevM opened this issue 3 years ago • 3 comments
trafficstars

🔗 Linked issue

#8922 (closed but there were a comments with explanations)

❓ Type of change

  • [x] 📖 Documentation (updates to the documentation or readme)
  • [ ] 🐞 Bug fix (a non-breaking change that fixes an issue)
  • [ ] 👌 Enhancement (improving an existing functionality like performance)
  • [ ] ✨ New feature (a non-breaking change that adds functionality)
  • [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Documentation for extensions and pathPrefix keys of components > dirs objects of nuxt.config.ts

📝 Checklist

  • [x] I have linked an issue or discussion.
  • [x] I have updated the documentation accordingly.

MorevM avatar Nov 12 '22 10:11 MorevM

CodeSandbox logoCodeSandbox logo  Open in CodeSandbox Web Editor | VS Code | VS Code Insiders

codesandbox[bot] avatar Nov 12 '22 10:11 codesandbox[bot]

Deploy Preview for nuxt3-docs ready!

Name Link
Latest commit 3ba7ff27f8175bbda6b477ba78061e9dd35320d7
Latest deploy log https://app.netlify.com/sites/nuxt3-docs/deploys/636f7ed3fe555e00086fd8ce
Deploy Preview https://deploy-preview-8930--nuxt3-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Nov 12 '22 10:11 netlify[bot]

@danielroe I wrote a docs as promised in nuxt/nuxt.js#15447

Spelling corrections are welcome, also I'm not sure should I use object form of components key in docs or not?

// This one
components: [
  { path: '...' },
],

// or this one
components: {
  dirs: [
    { path: '...' },
  ]
}

MorevM avatar Nov 12 '22 10:11 MorevM

merged in https://github.com/nuxt/framework/commit/28a2a91b64e16d499c69da1a1fb54871992b3b14.

danielroe avatar Jan 19 '23 13:01 danielroe