diff options
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. |