Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

1,311 Commits

Repository files navigation

🚀 AstroWind

AstroWind Lighthouse Score

🌟 Most starred & forked Astro theme in 2022, 2023, 2024 & 2025. 🌟

AstroWind is a free and open-source template to make your website using Astro v7 + Tailwind CSS v4. Ready to start a new project and designed taking into account web best practices.

  • Production-ready scores in PageSpeed Insights reports.
  • ✅ Integration with Tailwind CSS v4 supporting Dark mode and RTL.
  • Fast and SEO friendly blog with automatic RSS feed, MDX support, Categories & Tags, Social Share, ...
  • Image Optimization (using new Astro Assets and Unpic for Universal image CDN).
  • ✅ Generation of project sitemap based on your routes.
  • Open Graph tags for social media sharing.
  • Analytics built-in Google Analytics integration.

AstroWind Theme Screenshot

arthelokyoLicenseMaintainedContributions WelcomeKnown VulnerabilitiesStarsForks


Table of Contents

Demo

📌 https://astrowind.vercel.app/


🔔 Upcoming: AstroWind 2.0 – We Need Your Vision!

We're gearing up for AstroWind 2.0, and we want it to be shaped by you, our community. Join the discussion and share your ideas, suggestions, and feedback to help us make AstroWind even better.

Share Your Feedback in Our Discussion!


TL;DR

npm create astro@latest -- --template arthelokyo/astrowind

Getting started

AstroWind tries to give you quick access to creating a website using Astro v7 + Tailwind CSS v4. It's a free theme which focuses on simplicity, good practices and high performance.

Very little vanilla javascript is used only to provide basic functionality so that each developer decides which framework (React, Vue, Svelte, Solid JS...) to use and how to approach their goals.

Note: Requires Node.js >= 22.12.0. The template currently uses output: 'static', but the blog only works with prerender = true.

Project structure

Inside AstroWind template, you'll see the following folders and files:

/
├── public/
│ ├── _headers
│ └── robots.txt
├── src/
│ ├── assets/
│ │ ├── favicons/
│ │ ├── images/
│ │ └── styles/
│ │ └── tailwind.css
│ ├── components/
│ │ ├── blog/
│ │ ├── common/
│ │ ├── ui/
│ │ ├── widgets/
│ │ │ ├── Header.astro
│ │ │ └── ...
│ │ ├── CustomStyles.astro
│ │ ├── Favicons.astro
│ │ └── Logo.astro
│ ├── content.config.ts
│ ├── data/
│ │ └── post/
│ │ ├── post-slug-1.md
│ │ ├── post-slug-2.mdx
│ │ └── ...
│ ├── layouts/
│ │ ├── Layout.astro
│ │ ├── MarkdownLayout.astro
│ │ └── PageLayout.astro
│ ├── pages/
│ │ ├── [...blog]/
│ │ │ ├── [category]/
│ │ │ ├── [tag]/
│ │ │ ├── [...page].astro
│ │ │ └── index.astro
│ │ ├── index.astro
│ │ ├── 404.astro
│ │ ├-- rss.xml.ts
│ │ └── ...
│ ├── utils/
│ ├── config.yaml
│ └── navigation.ts
├── package.json
├── astro.config.ts
└── ...

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory if they do not require any transformation or in the assets/ directory if they are imported directly.

Edit AstroWind on CodeSandboxOpen in StackBlitz

🧑‍🚀 Seasoned astronaut? Delete this file README.md. Update src/config.yaml and contents. Have fun!


Commands

All commands are run from the root of the project, from a terminal:

CommandAction
npm installInstalls dependencies
npm run devStarts local dev server at localhost:4321
npm run buildBuild your production site to ./dist/
npm run previewPreview your build locally, before deploying
npm run checkCheck your project for errors
npm run fixRun Eslint and format codes with Prettier
npm run astro ...Run CLI commands like astro add, astro preview

Configuration

Basic configuration file: ./src/config.yaml

site:
name: 'Example'site: 'https://example.com'base: '/'# Change this if you need to deploy to Github Pages, for exampletrailingSlash: false # Generate permalinks with or without "/" at the endgoogleSiteVerificationId: false # Or some value,# Default SEO metadatametadata:
title:
default: 'Example'template: '%s — Example'description: 'This is the default meta description of Example website'robots:
index: truefollow: trueopenGraph:
site_name: 'Example'images:
- url: '~/assets/images/default.png'width: 1200height: 628type: websitetwitter:
handle: '@twitter_user'site: '@twitter_user'cardType: summary_large_imagei18n:
language: entextDirection: ltrapps:
blog:
isEnabled: true # If the blog will be enabledpostsPerPage: 6# Number of posts per pagepost:
isEnabled: truepermalink: '/blog/%slug%'# Variables: %slug%, %year%, %month%, %day%, %hour%, %minute%, %second%, %category%robots:
index: truelist:
isEnabled: truepathname: 'blog'# Blog main path, you can change this to "articles" (/articles)robots:
index: truecategory:
isEnabled: truepathname: 'category'# Category main path /category/some-category, you can change this to "group" (/group/some-category)robots:
index: truetag:
isEnabled: truepathname: 'tag'# Tag main path /tag/some-tag, you can change this to "topics" (/topics/some-category)robots:
index: falseisRelatedPostsEnabled: true # If a widget with related posts is to be displayed below each postrelatedPostsCount: 4# Number of related posts to displayanalytics:
vendors:
googleAnalytics:
id: null # or "G-XXXXXXXXXX"ui:
theme: 'system'# Values: "system" | "light" | "dark" | "light:only" | "dark:only"

Customize Design

With Tailwind CSS v4, all configuration is CSS-first. To customize Font families, Colors or more Elements refer to the following files:

  • src/components/CustomStyles.astro — CSS variables for colors and fonts
  • src/assets/styles/tailwind.css — Tailwind theme tokens (@theme), custom utilities (@utility), and plugins

Deploy

Deploy to production (manual)

You can create an optimized production build with:

npm run build

Now, your website is ready to be deployed. All generated files are located at dist folder, which you can deploy the folder to any hosting service you prefer.

Deploy to Netlify

Clone this repository on your own GitHub account and deploy it to Netlify:

Netlify Deploy button

Deploy to Vercel

Clone this repository on your own GitHub account and deploy to Vercel:

Deploy with Vercel

Deploy to PandaStack

Clone this repository on your own GitHub account and deploy to PandaStack:

Deploy to PandaStack


Contributing

If you have any ideas, suggestions or find any bugs, feel free to open a discussion, an issue or create a pull request. That would be very useful for all of us and we would be happy to listen and take action.

Acknowledgements

Initially created by Arthelokyo and maintained by a community of contributors.

License

AstroWind is licensed under the MIT license — see the LICENSE file for details.