Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@danielroe
Copy link
Member

πŸ”— 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. πŸ˜‰

danielroe and others added 4 commits January 23, 2024 15:53
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]>
@bolt-new-by-stackblitz
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@harlan-zw
Copy link
Contributor

This needs a bit of refactoring:

  • we don't expose useStyles anymore
  • inline asset strategy is not supported
  • the composable names convention is to be prefixed with useScript which is already updated upstream

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

Copy link
Member Author

danielroe commented Apr 22, 2024

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 useScript and any other composables that will trigger auto-install of nuxt/scripts with minimal docs pointing to the separate scripts docs website (like we do with nuxt/image).

Feel free to directly push to this branch πŸ™

@atinux
Copy link
Member

atinux commented Jan 13, 2025

What shall we do about this PR?

Copy link
Member Author

Thank you for the reminder!

I would love to see these documented on nuxt.com, with links to the latest info on https://scripts.nuxt.com, much as we do for nuxt/image.

If someone has the time to sync the PR with the latest state on scripts.nuxt.com, that would be perfect πŸ™

@atinux
Copy link
Member

atinux commented Jan 14, 2025

cc @Mini-ghost is this something you feel you can tackle?

@harlan-zw
Copy link
Contributor

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.

@Mini-ghost
Copy link
Member

It’s my honor! I will do my best to understand the implementation of nuxt scripts and try to complete this part. πŸ’ͺ

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants