diff options
author | 2021-07-21 18:10:03 -0500 | |
---|---|---|
committer | 2021-07-21 18:10:03 -0500 | |
commit | bd18e14a2c05d473b9822ddaf9ebada48e2d75dd (patch) | |
tree | 6962207c8b3c553b3df675320f4e3a177e7516fc /examples/framework-vue/README.md | |
parent | ba6b47eda7589b4794b52218457229bb04e7d139 (diff) | |
download | astro-bd18e14a2c05d473b9822ddaf9ebada48e2d75dd.tar.gz astro-bd18e14a2c05d473b9822ddaf9ebada48e2d75dd.tar.zst astro-bd18e14a2c05d473b9822ddaf9ebada48e2d75dd.zip |
Expose JSX compilation to renderers (#588)
* feat: add support for `jsxImportSource`, new JSX transform
* Renderer: add Solid renderer (#667)
* feat: add support for `jsxImportSource`, new JSX transform
* WIP: solid renderer
* [Renderer] Solid (#656)
* feat: add support for `jsxImportSource`, new JSX transform
* WIP: solid renderer
* Solid renderer: fix SSR of children, hydration (top level)
Caveat: cannot hydrate children/descendants of hydrated parents
* Fix hydration of fragments
* fix: SyntaxError in React/Preact renderers
* fix: errors in React/Preact renderers
* feat: update react external
* chore: update examples
* chore: delete old changelog
* chore: update astro config
Co-authored-by: Nate Moore <nate@skypack.dev>
* Changing the preact to Solid (#669)
* chore: use new client:visible syntax
* fix: dev script issue
* chore: cleanup SolidJS example
* docs: update framework example docs
* chore: cleanup framework-multiple example
* fix: remove SolidJS false-positives from Preact renderer
* chore: add changeset
Co-authored-by: eyelidlessness <eyelidlessness@users.noreply.github.com>
Co-authored-by: Abdullah Mzaien <s201540830@kfupm.edu.sa>
* feat(create-astro): add Solid support
* docs: add JSX options to renderer reference
* chore: add changeset for P/React renderers
* fix: move react/server.js to external
* chore: remove brewfile
* Revert "feat: add support for `jsxImportSource`, new JSX transform"
This reverts commit 077c4bfc135c58a85d4ebfca6012e90403694d8d.
* fix: remove `react-dom/server` from `external`
* chore: remove unused dependency
* feat: improve JSX error messages
* Revert "Revert "feat: add support for `jsxImportSource`, new JSX transform""
This reverts commit f6c2896b9ec6430611fc0abae7d586c42aca87e5.
* docs: update jsxImportSource
* feat: improve error message
* feat: improve error logging for JSX renderers
* tests: add jsx-runtime tests
* chore: update snowpack
Co-authored-by: eyelidlessness <eyelidlessness@users.noreply.github.com>
Co-authored-by: Abdullah Mzaien <s201540830@kfupm.edu.sa>
Diffstat (limited to 'examples/framework-vue/README.md')
-rw-r--r-- | examples/framework-vue/README.md | 35 |
1 files changed, 32 insertions, 3 deletions
diff --git a/examples/framework-vue/README.md b/examples/framework-vue/README.md index c5818e51f..2c6240f01 100644 --- a/examples/framework-vue/README.md +++ b/examples/framework-vue/README.md @@ -1,9 +1,38 @@ # Using Vue with Astro -``` +This example showcases Astro's built-in support for [Vue](https://v3.vuejs.org/). + +## Installation + +### Automatic + +Bootstrap your Astro project with this template! + +```shell npm init astro -- --template framework-vue ``` -This example showcases Astro's built-in support for [Vue (`v3.x`)](https://v3.vuejs.org/). +### Manual + +To use Vue components in your Astro project: + +1. Install `@astrojs/renderer-vue` + + ```shell + npm i @astrojs/renderer-vue + ``` + +2. Add `"@astrojs/renderer-vue"` to your `renderers` in `astro.config.mjs`. + + ```js + export default { + renderers: [ + "@astrojs/renderer-vue", + // optionally, others... + ] + } + ``` + +## Usage -No configuration is needed to enable Vue support—just start writing Vue components in `src/components`. +Write your Vue components as `.vue` files in your project. |