docs: add example for accessing vite config programmatically

[danielroe]

🔗 Linked issue

#14534

❓ Type of change

• 📖 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 PR adds docs for an example way to access configuration information using Nuxt Kit utilities.

📝 Checklist

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

[codesandbox]

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

[pi0]

As we are documenting the usage and there are some valid use cases, I believe we should still expose it as a @nuxt/kit utility. At least managing and unifying the workarounds behind it.

[floroz]

Thank you @danielroe for exposing this documentation.

I am on nuxt@3.1.2 and I get a TS error for the signature of the option of loadNuxt

Type '{ cwd: string; dev: false; ssr: boolean; }' is not assignable to type 'LoadNuxtOptions'.
  Object literal may only specify known properties, and 'ssr' does not exist in type 'LoadNuxtOptions'.

[danielroe]

@floroz Thanks for catching that - fixed ✅