summaryrefslogtreecommitdiff
path: root/packages/renderers/renderer-vue/README.md
diff options
context:
space:
mode:
authorGravatar Drew Powers <1369770+drwpow@users.noreply.github.com> 2021-09-14 17:26:23 -0600
committerGravatar GitHub <noreply@github.com> 2021-09-14 16:26:23 -0700
commit97d37f8f49981ad04dca01dad596846fd0725d41 (patch)
treeda978f53c2a700dc8cccc431df0e7d29efb7aec8 /packages/renderers/renderer-vue/README.md
parent5237db20b93d4c5c44fb4ae95e250f487999cfb9 (diff)
downloadastro-97d37f8f49981ad04dca01dad596846fd0725d41.tar.gz
astro-97d37f8f49981ad04dca01dad596846fd0725d41.tar.zst
astro-97d37f8f49981ad04dca01dad596846fd0725d41.zip
Docs: Add READMEs for renderers (#1351)
* Add README stub for renderers * Add renderer READMEs
Diffstat (limited to '')
-rw-r--r--packages/renderers/renderer-vue/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/packages/renderers/renderer-vue/README.md b/packages/renderers/renderer-vue/README.md
new file mode 100644
index 000000000..fb4146061
--- /dev/null
+++ b/packages/renderers/renderer-vue/README.md
@@ -0,0 +1,31 @@
+# @astrojs/renderer-vue
+
+This is a plugin for [Astro][astro] apps that enables server-side rendering of Vue 3.x components.
+
+## Installation
+
+Install `@astrojs/renderer-vue` and then add it to your `astro.config.mjs` in the `renderers` property:
+
+```
+npm install @astrojs/renderer-vue
+```
+
+__astro.config.mjs__
+
+```js
+export default {
+ // ...
+
+ renderers: [
+ // ...
+ '@astrojs/renderer-vue'
+ ]
+}
+```
+
+## Documentation
+
+[Astro Renderer Documentation][renderer-docs]
+
+[astro]: https://astro.build
+[renderer-docs]: https://docs.astro.build/reference/renderer-reference