Skip to content
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

docs: add third parties + scripts documentation #26854

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

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 <houssein.djirdeh@gmail.com>
Co-authored-by: Julien Huang <julien.h.dev@gmail.com>
Co-authored-by: Damian Głowala <damian.glowala.rebkow@gmail.com>
Co-authored-by: Thorsten Kober <thorstenk@google.com>
Co-authored-by: Kara <kara@users.noreply.github.com>
Co-authored-by: Damian Głowala <damian.glowala.rebkow@gmail.com>
Co-authored-by: Houssein Djirdeh <houssein.djirdeh@gmail.com>
Co-authored-by: Julien Huang <julien.h.dev@gmail.com>
Copy link

stackblitz bot commented Apr 19, 2024

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 🙏

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.

None yet

4 participants