Skip to content

Commit

Permalink
docs: add Astro integration page (#1283)
Browse files Browse the repository at this point in the history
Co-authored-by: Remus Mate <3297808+mrm007@users.noreply.github.com>
Co-authored-by: Mirko Basic bejzik8@gmail.com
  • Loading branch information
JoshuaKGoldberg and mrm007 authored Jan 25, 2024
1 parent b7c182b commit 39909db
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 0 deletions.
1 change: 1 addition & 0 deletions site/contents.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ const contents = [
group: 'integrations',
label: 'Integrations',
pages: [
'astro',
'esbuild',
'gatsby',
'next',
Expand Down
65 changes: 65 additions & 0 deletions site/docs/integrations/astro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
title: Astro
parent: integrations
---

# Astro

Integrating Vanilla Extract with [Astro](https://astro.build) is done with the help of the [Vite plugin][vite integration].

## Installation

```bash
npm install @vanilla-extract/css
npm install @vanilla-extract/vite-plugin --save-dev
```

## Setup

Add Vanilla Extract Vite plugin to the Astro configuration:

```js
import { defineConfig } from 'astro/config';
import { vanillaExtractPlugin } from '@vanilla-extract/vite-plugin';

// https://astro.build/config
export default defineConfig({
vite: {
plugins: [vanillaExtractPlugin()]
}
});
```

You'll then be able to use `style` and other APIs in `.css.ts` files.

```ts
// button.css.ts

import { style } from '@vanilla-extract/css';

export const button = style({
padding: '0.5rem 1rem',
border: 'none',
borderRadius: '0.25rem',
color: 'white',
background: '#333'
});
```

And now you can reference styles in your Astro component:

```tsx
// Button.astro

---
import { button } from './button.css'
---

<button class={button}>Click Me!</button>
```

## Configuration

See the [Vite integration page][vite integration] for documentation on the Vite plugin.

[vite integration]: /documentation/integrations/vite

0 comments on commit 39909db

Please sign in to comment.