AstroWind is a free and open-source template to make your website using Astro + Tailwind CSS. Ready to start a new project and designed taking into account best practices.
- β Integration with Tailwind CSS (@astrojs/tailwind) supporting Dark mode.
- β Production-ready scores in Lighthouse and PageSpeed Insights reports.
- β Fast and SEO friendly blog with automatic RSS feed (@astrojs/rss), MDX support, Categories & Tags, Social Share buttons, ...
- β Image optimization (@astrojs/images) and Font optimization.
- β Generation of project sitemap based on your routes (@astrojs/sitemap).
- β Open Graph tags for social media sharing.
- β Analytics built-in Google Analytics, and Splitbee integration.
Table of Contents
π https://astrowind.vercel.app/
AstroWind tries to give you quick access to creating a website using Astro + Tailwind CSS. It's a free theme 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, Angular, Vue, Svelte, Solid JS...) to use and how to approach their goals..
Inside AstroWind template, you'll see the following folders and files:
/
βββ data/
| βββ blog/
| βββ post-slug-1.md
| βββ post-slug-2.mdx
| βββ ...
βββ public/
β βββ robots.txt
β βββ favicon.ico
βββ src/
β βββ assets/
β β βββ images/
| | βββ styles/
| | βββ base.css
β βββ components/
β β βββ atoms/
β β βββ blog/
β β βββ core/
| | βββ widgets/
| | βββ Header.astro
| | βββ Footer.astro
| | βββ ...
β βββ layouts/
β | |ββ BaseLayout.astro
β | βββ ...
β βββ pages/
β | βββ [...blog]/
| | | βββ [...page].astro
| | | βββ [slug].astro
β | βββ [...categories]/
| | | βββ [category]/
| | | βββ [...page].astro
β | βββ [...tags]/
| | | βββ [tag]/
| | | βββ [...page].astro
β | βββ index.astro
| | βββ 404.astro
| | β-- rss.xml.js
β βββ utils/
β βββ config.mjs
βββ package.json
βββ ...
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. Update
config.mjs
and contents. Have fun!
All commands are run from the root of the project, from a terminal:
Command | Action |
---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:3000 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run format |
Format codes with Prettier |
npm run lint:eslint |
Run Eslint |
npm run astro ... |
Run CLI commands like astro add , astro preview |
Basic configuration file: ./src/config.mjs
export const SITE = {
name: 'Example',
origin: 'https://example.com',
basePathname: '/', // Change this if you need to deploy to Github Pages, for example
trailingSlash: false, // Generate permalinks with or without "/" at the end
title: 'Example - This is the homepage title of Example',
description: 'This is the homepage description of Example',
googleAnalyticsId: false, // or "G-XXXXXXXXXX",
googleSiteVerificationId: false, // or some value,
};
export const BLOG = {
disabled: false,
postsPerPage: 4,
blog: {
disabled: false,
pathname: 'blog', // blog main path, you can change this to "articles" (/articles)
},
post: {
disabled: false,
pathname: '', // empty for /some-post, value for /pathname/some-post
},
category: {
disabled: false,
pathname: 'category', // set empty to change from /category/some-category to /some-category
},
tag: {
disabled: false,
pathname: 'tag', // set empty to change from /tag/some-tag to /some-tag
},
};
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.
Clone this repository on own GitHub account and deploy to Netlify:
Clone this repository on own GitHub account and deploy to Vercel:
- Project:
- Create simple and clear strategy to get template updates
- Blog:
- Improve blog design
- Create component or utilities for related posts
- Add more shortcodes or embed functions to posts in Markdown: (eg video, tweet...)
- More widgets:
- Add more Tailwind components useful for most scenarios (Features, Contact, Call to Actions, Content, FAQs ...)
- Create external library or place with useful Tailwind components
- More Examples: Add commonly used example pages (Ex: About, Terms, Services...)
- Documentation: Create detailed documentation with best practices and redesign tips
- Why?
If you have any idea, 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 by onWidget and maintained by a community of contributors.
AstroWind is licensed under the Unlicense license β see the LICENSE file for details.