aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> 2025-06-05 12:45:05 +0000
committerGravatar github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> 2025-06-05 12:45:05 +0000
commitba8164f9bafe4eab5b2353d3c4fbc4b872d328d4 (patch)
tree3dcff3b78de15e03adeb407f26729fd1cd14cbb7
downloadastro-examples/with-tailwindcss.tar.gz
astro-examples/with-tailwindcss.tar.zst
astro-examples/with-tailwindcss.zip
Sync from 0947a69192ad6820970902c7c951fb0cf31fcf4bexamples/with-tailwindcss
-rw-r--r--.codesandbox/Dockerfile1
-rw-r--r--.gitignore24
-rw-r--r--README.md13
-rw-r--r--astro.config.mjs10
-rw-r--r--package.json20
-rw-r--r--public/favicon.svg9
-rw-r--r--src/components/Button.astro19
-rw-r--r--src/layouts/main.astro16
-rw-r--r--src/pages/index.astro25
-rw-r--r--src/pages/markdown-page.md16
-rw-r--r--src/styles/global.css1
-rw-r--r--tsconfig.json5
12 files changed, 159 insertions, 0 deletions
diff --git a/.codesandbox/Dockerfile b/.codesandbox/Dockerfile
new file mode 100644
index 000000000..c3b5c81a1
--- /dev/null
+++ b/.codesandbox/Dockerfile
@@ -0,0 +1 @@
+FROM node:18-bullseye
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 000000000..16d54bb13
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,24 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+
+# jetbrains setting folder
+.idea/
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..8b512bb7f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Astro with Tailwind
+
+```sh
+npm create astro@latest -- --template with-tailwindcss
+```
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-tailwindcss)
+[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/with-tailwindcss)
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/with-tailwindcss/devcontainer.json)
+
+Astro comes with [Tailwind](https://tailwindcss.com) support out of the box. This example showcases how to style your Astro project with Tailwind.
+
+For complete setup instructions, please see our [Tailwind Integration Guide](https://docs.astro.build/en/guides/integrations-guide/tailwind).
diff --git a/astro.config.mjs b/astro.config.mjs
new file mode 100644
index 000000000..832a62b06
--- /dev/null
+++ b/astro.config.mjs
@@ -0,0 +1,10 @@
+// @ts-check
+import { defineConfig } from 'astro/config';
+import tailwindcss from '@tailwindcss/vite';
+
+// https://astro.build/config
+export default defineConfig({
+ vite: {
+ plugins: [tailwindcss()]
+ }
+});
diff --git a/package.json b/package.json
new file mode 100644
index 000000000..4e86ff23e
--- /dev/null
+++ b/package.json
@@ -0,0 +1,20 @@
+{
+ "name": "@example/with-tailwindcss",
+ "type": "module",
+ "version": "0.0.1",
+ "private": true,
+ "scripts": {
+ "dev": "astro dev",
+ "build": "astro build",
+ "preview": "astro preview",
+ "astro": "astro"
+ },
+ "dependencies": {
+ "@astrojs/mdx": "^4.3.0",
+ "@tailwindcss/vite": "^4.1.3",
+ "@types/canvas-confetti": "^1.9.0",
+ "astro": "^5.9.0",
+ "canvas-confetti": "^1.9.3",
+ "tailwindcss": "^4.1.3"
+ }
+}
diff --git a/public/favicon.svg b/public/favicon.svg
new file mode 100644
index 000000000..f157bd1c5
--- /dev/null
+++ b/public/favicon.svg
@@ -0,0 +1,9 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 128 128">
+ <path d="M50.4 78.5a75.1 75.1 0 0 0-28.5 6.9l24.2-65.7c.7-2 1.9-3.2 3.4-3.2h29c1.5 0 2.7 1.2 3.4 3.2l24.2 65.7s-11.6-7-28.5-7L67 45.5c-.4-1.7-1.6-2.8-2.9-2.8-1.3 0-2.5 1.1-2.9 2.7L50.4 78.5Zm-1.1 28.2Zm-4.2-20.2c-2 6.6-.6 15.8 4.2 20.2a17.5 17.5 0 0 1 .2-.7 5.5 5.5 0 0 1 5.7-4.5c2.8.1 4.3 1.5 4.7 4.7.2 1.1.2 2.3.2 3.5v.4c0 2.7.7 5.2 2.2 7.4a13 13 0 0 0 5.7 4.9v-.3l-.2-.3c-1.8-5.6-.5-9.5 4.4-12.8l1.5-1a73 73 0 0 0 3.2-2.2 16 16 0 0 0 6.8-11.4c.3-2 .1-4-.6-6l-.8.6-1.6 1a37 37 0 0 1-22.4 2.7c-5-.7-9.7-2-13.2-6.2Z" />
+ <style>
+ path { fill: #000; }
+ @media (prefers-color-scheme: dark) {
+ path { fill: #FFF; }
+ }
+ </style>
+</svg>
diff --git a/src/components/Button.astro b/src/components/Button.astro
new file mode 100644
index 000000000..167927fb3
--- /dev/null
+++ b/src/components/Button.astro
@@ -0,0 +1,19 @@
+---
+// Click button, get confetti!
+// Styled by Tailwind :)
+---
+
+<button
+ class="appearance-none py-2 px-4 bg-purple-500 text-white font-semibold rounded-lg shadow-md hover:bg-purple-700 focus:outline-none focus:ring-2 focus:ring-purple-400 focus:ring-opacity-75"
+>
+ <slot />
+</button>
+
+<script>
+ import confetti from 'canvas-confetti';
+ const button = document.body.querySelector('button');
+
+ if (button) {
+ button.addEventListener('click', () => confetti());
+ }
+</script>
diff --git a/src/layouts/main.astro b/src/layouts/main.astro
new file mode 100644
index 000000000..0a9423176
--- /dev/null
+++ b/src/layouts/main.astro
@@ -0,0 +1,16 @@
+---
+import '../styles/global.css';
+const { content } = Astro.props;
+---
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width" />
+ <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
+ <title>{content.title}</title>
+ </head>
+ <body>
+ <slot />
+ </body>
+</html>
diff --git a/src/pages/index.astro b/src/pages/index.astro
new file mode 100644
index 000000000..6350a3330
--- /dev/null
+++ b/src/pages/index.astro
@@ -0,0 +1,25 @@
+---
+import '../styles/global.css';
+// Component Imports
+import Button from '../components/Button.astro';
+
+// Full Astro Component Syntax:
+// https://docs.astro.build/basics/astro-components/
+---
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width" />
+ <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
+ <meta name="generator" content={Astro.generator} />
+ <title>Astro + TailwindCSS</title>
+ </head>
+
+ <body>
+ <div class="grid place-items-center h-screen content-center">
+ <Button>Tailwind Button in Astro!</Button>
+ <a href="/markdown-page" class="p-4 underline">Markdown is also supported...</a>
+ </div>
+ </body>
+</html>
diff --git a/src/pages/markdown-page.md b/src/pages/markdown-page.md
new file mode 100644
index 000000000..de11d381b
--- /dev/null
+++ b/src/pages/markdown-page.md
@@ -0,0 +1,16 @@
+---
+title: 'Markdown + Tailwind'
+layout: ../layouts/main.astro
+---
+
+<div class="grid place-items-center h-screen content-center">
+ <div class="py-2 px-4 bg-purple-500 text-white font-semibold rounded-lg shadow-md">
+ Tailwind classes also work in Markdown!
+ </div>
+ <a
+ href="/"
+ class="p-4 underline hover:text-purple-500 transition-colors ease-in-out duration-200"
+ >
+ Go home
+ </a>
+</div>
diff --git a/src/styles/global.css b/src/styles/global.css
new file mode 100644
index 000000000..d4b507858
--- /dev/null
+++ b/src/styles/global.css
@@ -0,0 +1 @@
+@import 'tailwindcss';
diff --git a/tsconfig.json b/tsconfig.json
new file mode 100644
index 000000000..8bf91d3bb
--- /dev/null
+++ b/tsconfig.json
@@ -0,0 +1,5 @@
+{
+ "extends": "astro/tsconfigs/strict",
+ "include": [".astro/types.d.ts", "**/*"],
+ "exclude": ["dist"]
+}