Clarify preact/compat integration docs #4267
Conversation
🦋 Changeset detectedLatest commit: 74028d5 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
pkg: preact
| > **Note** | ||
| > Currently, the `compat` option only works for React libraries that export code as ESM. If an error happens during build-time, try adding the library to `vite.ssr.noExternal: ['the-react-library']` in your `astro.config.mjs` file. |
There was a problem hiding this comment.
not related to the content but i just noticed the github note syntax creates a blockquote
i'm guessing we don't want to use the custom admonition syntax in the readmes
:::note
Currently, the `compat`...
:::
since the github syntax is consistent, maybe there's a transformation that could happen in remark? /cc @sarah11918 @delucis
There was a problem hiding this comment.
Well spotted @mayank99! That's actually something I've been wanting to add: use GitHub's syntax in these files and then automatically transform them in docs withastro/docs#967
Changes
Close #4107
Spent a fair bit of time with this today, and I think this is the best we can do at the moment:
reactandreact-domto@preact/compatto intercept the alias into nested packages.ssr.noExternal.red: extra context #4107 (comment)
Testing
N/A (docs change)
Docs
Updated preact readme