🚀 AstroWind

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

AstroWind is a free and open-source template to make your website using Astro 5.0 + Tailwind CSS. 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 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, and Splitbee integration.

• Demo
• Upcoming: AstroWind 2.0 – We Need Your Vision!
• TL;DR
• Getting started
  • Project structure
  • Commands
  • Configuration
  • Deploy
• Frequently Asked Questions
• Related Projects
• Contributing
• Acknowledgements
• License

Demo

📌 https://astrowind.vercel.app/

🔔 Upcoming: AstroWind 2.0 – We Need Your Vision!

We're embarking on an exciting journey with AstroWind 2.0, and we want you to be a part of it! We're currently taking the first steps in developing this new version and your insights are invaluable. Join the discussion and share your feedback, ideas, and suggestions to help shape the future of AstroWind. Let's make AstroWind 2.0 even better, together!

Share Your Feedback in Our Discussion!

TL;DR

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

Getting started

AstroWind tries to give you quick access to creating a website using Astro 5.0 + Tailwind CSS. 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.

In this version the template supports all the options in the output configuration, static, hybrid and server, but the blog only works with prerender = true. We are working on the next version and aim to make it fully compatible with SSR.

Project structure

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

1
/
2
├── public/
3
│   ├── _headers
4
│   └── robots.txt
5
├── src/
6
│   ├── assets/
7
│   │   ├── favicons/
8
│   │   ├── images/
9
│   │   └── styles/
10
│   │       └── tailwind.css
11
│   ├── components/
12
│   │   ├── blog/
13
│   │   ├── common/
14
│   │   ├── ui/
15
│   │   ├── widgets/
16
│   │   │   ├── Header.astro
17
│   │   │   └── ...
18
│   │   ├── CustomStyles.astro
19
│   │   ├── Favicons.astro
20
│   │   └── Logo.astro
21
│   ├── content/
22
│   │   ├── post/
23
│   │   │   ├── post-slug-1.md
24
│   │   │   ├── post-slug-2.mdx
25
│   │   │   └── ...
26
│   │   └-- config.ts
27
│   ├── layouts/
28
│   │   ├── Layout.astro
29
│   │   ├── MarkdownLayout.astro
30
│   │   └── PageLayout.astro
31
│   ├── pages/
32
│   │   ├── [...blog]/
33
│   │   │   ├── [category]/
34
│   │   │   ├── [tag]/
35
│   │   │   ├── [...page].astro
36
│   │   │   └── index.astro
37
│   │   ├── index.astro
38
│   │   ├── 404.astro
39
│   │   ├-- rss.xml.ts
40
│   │   └── ...
41
│   ├── utils/
42
│   ├── config.yaml
43
│   └── navigation.js
44
├── package.json
45
├── astro.config.ts
46
└── ...

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.

🧑‍🚀 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:

Configuration

Basic configuration file: ./src/config.yaml

1
site:
2
  name: 'Example'
3
  site: 'https://example.com'
4
  base: '/' # Change this if you need to deploy to Github Pages, for example
5
  trailingSlash: false # Generate permalinks with or without "/" at the end
6

7
  googleSiteVerificationId: false # Or some value,
8

9
# Default SEO metadata
10
metadata:
11
  title:
12
    default: 'Example'
13
    template: '%s — Example'
14
  description: 'This is the default meta description of Example website'
15
  robots:
16
    index: true
17
    follow: true
18
  openGraph:
19
    site_name: 'Example'
20
    images:
21
      - url: '~/assets/images/default.png'
22
        width: 1200
23
        height: 628
24
    type: website
25
  twitter:
26
    handle: '@twitter_user'
27
    site: '@twitter_user'
28
    cardType: summary_large_image
29

30
i18n:
31
  language: en
32
  textDirection: ltr
33

34
apps:
35
  blog:
36
    isEnabled: true # If the blog will be enabled
37
    postsPerPage: 6 # Number of posts per page
38

39
    post:
40
      isEnabled: true
41
      permalink: '/blog/%slug%' # Variables: %slug%, %year%, %month%, %day%, %hour%, %minute%, %second%, %category%
42
      robots:
43
        index: true
44

45
    list:
46
      isEnabled: true
47
      pathname: 'blog' # Blog main path, you can change this to "articles" (/articles)
48
      robots:
49
        index: true
50

51
    category:
52
      isEnabled: true
53
      pathname: 'category' # Category main path /category/some-category, you can change this to "group" (/group/some-category)
54
      robots:
55
        index: true
56

57
    tag:
58
      isEnabled: true
59
      pathname: 'tag' # Tag main path /tag/some-tag, you can change this to "topics" (/topics/some-category)
60
      robots:
61
        index: false
62

63
    isRelatedPostsEnabled: true # If a widget with related posts is to be displayed below each post
64
    relatedPostsCount: 4 # Number of related posts to display
65

66
analytics:
67
  vendors:
68
    googleAnalytics:
69
      id: null # or "G-XXXXXXXXXX"
70

71
ui:
72
  theme: 'system' # Values: "system" | "light" | "dark" | "light:only" | "dark:only"

Customize Design

To customize Font families, Colors or more Elements refer to the following files:

• src/components/CustomStyles.astro
• src/assets/styles/tailwind.css

Deploy

Deploy to production (manual)

You can create an optimized production build with:

1
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:

Deploy to Vercel

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

Frequently Asked Questions

• Why?

Related projects

• TailNext - Free template using Next.js 14 and Tailwind CSS with the new App Router.
• Qwind - Free template to make your website using Qwik + Tailwind CSS.

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.