summaryrefslogtreecommitdiff
path: root/examples/framework-multiple/README.md
diff options
context:
space:
mode:
authorGravatar Nate Moore <natemoo-re@users.noreply.github.com> 2021-06-28 10:46:10 -0500
committerGravatar GitHub <noreply@github.com> 2021-06-28 10:46:10 -0500
commit7063c04dec48fcabcda104c42d61642a554f6044 (patch)
treeccc57515b9609f9a211154e2a783ab324ee1b8ed /examples/framework-multiple/README.md
parent13f50564cb8cfece7857c7b08be064d5e9e9853a (diff)
downloadastro-7063c04dec48fcabcda104c42d61642a554f6044.tar.gz
astro-7063c04dec48fcabcda104c42d61642a554f6044.tar.zst
astro-7063c04dec48fcabcda104c42d61642a554f6044.zip
Restructure examples (#568)
* rename kitchen sink, pull out react example * split out the rest of the examples * align versions * chore: rename examples * chore: normalize gitignore * chore: update package versions * chore: move framework examples to `framework` namespace * docs: add README to examples Co-authored-by: Austin Crim <crim.austin@principal.com>
Diffstat (limited to 'examples/framework-multiple/README.md')
-rw-r--r--examples/framework-multiple/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/examples/framework-multiple/README.md b/examples/framework-multiple/README.md
new file mode 100644
index 000000000..42f8e2b1f
--- /dev/null
+++ b/examples/framework-multiple/README.md
@@ -0,0 +1,7 @@
+# Using Preact with Astro
+
+This example showcases Astro's built-in support for multiple frameworks ([React](https://reactjs.org), [Preact](https://preactjs.com), [Svelte](https://svelte.dev), and [Vue (`v3.x`)](https://v3.vuejs.org/)).
+
+No configuration is needed to enable these frameworks—just start writing components in `src/components`.
+
+> **Note**: If used, components _must_ include a JSX factory (ex. `import React from "react"`, `import { h } from "preact"`). Astro is unable to determine which framework is used without having the [JSX factory](https://mariusschulz.com/blog/per-file-jsx-factories-in-typescript#what-is-a-jsx-factory) in scope.