diff options
Diffstat (limited to 'examples/framework-solid/README.md')
-rw-r--r-- | examples/framework-solid/README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/examples/framework-solid/README.md b/examples/framework-solid/README.md new file mode 100644 index 000000000..e7afc1b84 --- /dev/null +++ b/examples/framework-solid/README.md @@ -0,0 +1,38 @@ +# Using Solid with Astro + +This example showcases Astro's built-in support for [Solid](https://www.solidjs.com/). + +## Installation + +### Automatic + +Bootstrap your Astro project with this template! + +```shell +npm init astro --template framework-solid +``` + +### Manual + +To use Solid components in your Astro project: + +1. Install `@astrojs/renderer-solid` + + ```shell + npm i @astrojs/renderer-solid + ``` + +2. Add `"@astrojs/renderer-solid"` to your `renderers` in `astro.config.mjs`. + + ```js + export default { + renderers: [ + "@astrojs/renderer-solid", + // optionally, others... + ] + } + ``` + +## Usage + +Write your Solid components as `.jsx` or `.tsx` files in your project. |