framework icon indicating copy to clipboard operation
framework copied to clipboard

docs: external configuration table

Open nathanchase opened this issue 3 years ago • 1 comments

🔗 Linked issue

#9188

❓ 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

This is an attempt to help clarify how common external packages/modules/scripts are configured with Nuxt 3, as referenced at https://github.com/nuxt/framework/pull/9181#issuecomment-1320899406

Here's a preview of how it might appear:

image

I also asked in Discord for community feedback on this: https://discord.com/channels/473401852243869706/897487139888062506/1043551067197165598

📝 Checklist

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

nathanchase avatar Nov 19 '22 15:11 nathanchase

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

codesandbox[bot] avatar Nov 19 '22 15:11 codesandbox[bot]

Thanks @danielroe & @HigherOrderLogic - changes have been committed.

nathanchase avatar Nov 20 '22 17:11 nathanchase

Thanks for working on this @nathanchase ❤️

I've pushed a few refactors to simplify and improve readability and also only include relevant to Nuxt 3 files.

image

pi0 avatar Nov 21 '22 12:11 pi0