Repository files navigation

🌟Moststarred &forked Astro theme in 2022, 2023 & 2024. 🌟

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

• ✅Production-ready scores inPageSpeed Insights reports.
• ✅ Integration withTailwind CSS supportingDark mode andRTL.
• ✅Fast and SEO friendly blog with automaticRSS feed,MDX support,Categories & Tags,Social Share, ...
• ✅Image Optimization (using newAstro Assets andUnpic for Universal image CDN).
• ✅ Generation ofproject sitemap based on your routes.
• ✅Open Graph tags for social media sharing.
• ✅Analytics built-in Google Analytics, and Splitbee integration.

📌https://astrowind.vercel.app/

We're embarking on an exciting journey withAstroWind 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 ofAstroWind. Let's makeAstroWind 2.0 even better, together!

Share Your Feedback in Our Discussion!

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

AstroWind tries to give you quick access to creating a website usingAstro 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 theoutput configuration,static,hybrid andserver, but the blog only works withprerender = true. We are working on the next version and aim to make it fully compatible with SSR.

InsideAstroWind 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/│   │   ├── post/│   │   │   ├── post-slug-1.md│   │   │   ├── post-slug-2.mdx│   │   │   └── ...│   │   └-- config.ts│   ├── 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.js├── package.json├── astro.config.ts└── ...

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

There's nothing special aboutsrc/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 thepublic/ directory if they do not require any transformation or in theassets/ directory if they are imported directly.

🧑‍🚀Seasoned astronaut? Delete this fileREADME.md. Updatesrc/config.yaml and contents. Have fun!

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

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"

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

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

You can create an optimized production build with:

npm run build

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

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

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

• Why?

• 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.

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.

Initially created byArthelokyo and maintained by a community ofcontributors.

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