-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
docs: add third parties + scripts documentation #26854
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.
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
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Houssein Djirdeh <[email protected]> Co-authored-by: Julien Huang <[email protected]> Co-authored-by: Damian GΕowala <[email protected]>
Co-authored-by: Thorsten Kober <[email protected]> Co-authored-by: Kara <[email protected]> Co-authored-by: Damian GΕowala <[email protected]> Co-authored-by: Houssein Djirdeh <[email protected]> Co-authored-by: Julien Huang <[email protected]>
|
|
|
This needs a bit of refactoring:
We need quite a bit of documentation and I don't think the Nuxt core repo is the place for it, so I'm making a dedicated docs site. I intend to pick any usable content from this draft into that. So not sure what you want to do with this PR |
|
For now, I think we need authoritative source of docs in standalone nuxt/scripts docs website. Ultimately we might reconsider merging them back into nuxt.com when API surface is stable and docs changes are few or nuxt/scripts is automatically installed as a dependency of Nuxt. But until then, we should document key utilities like Feel free to directly push to this branch π |
|
What shall we do about this PR? |
|
Thank you for the reminder! I would love to see these documented on If someone has the time to sync the PR with the latest state on scripts.nuxt.com, that would be perfect π |
|
cc @Mini-ghost is this something you feel you can tackle? |
|
Sounds good to me. I'll flag that there will be likely many breaking changes for v1 and the documentation will become more complex. For example the Google Maps integration will feature a lot more components so these may get split on to other doc pages. If we want a quick & easy solution, I'd just copy + paste from https://github.com/nuxt/scripts/blob/main/docs/content/docs/3.api/1.use-script.md with a canonical URL back to scripts.nuxt.com. I'd leave out specific third-parties for now while I work on getting them more stable. |
|
Itβs my honor! I will do my best to understand the implementation of nuxt scripts and try to complete this part. πͺ |
π Linked issue
π Description
π§ This is a WIP pull request to add documentation for coming nuxt third-parties/scripts implementations.
It's very much subject to change, so don't rely too much on this for now. π