THIS IS BASED ON: "🚀 AstroWind"

FIRST OF ALL: Big, big thanks to onwidget for starting this! Really amazing work. Because it's open-source, I'm comfortable using this as a base to craft specific experiences. Thank you!!

original Readme: 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.

Features

✅ 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

Demo
Getting started
Roadmap
Frequently Asked Questions
Related Projects
Contributing
Acknowledgements
License

Demo

📌 https://astrowind.vercel.app/

Getting started

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, Vue, Svelte, Solid JS...) to use and how to approach their goals..

Project structure

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!

Commands

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`

Configuration

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
  },
};

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 own GitHub account and deploy to Netlify:

Deploy to Vercel

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

Roadmap

Base

Improve blog design (More generic design that adapts to more needs).
Create component or utilities for related posts.
Add more shortcodes or embed functions to posts in Markdown: (eg Video, Tweet...).
Add more Tailwind components useful for most scenarios (Features, Contact, Call to Actions, Content, FAQs...)
Add commonly used example pages (Ex: About, Terms, Profile, Services...).
Create detailed documentation with best practices and redesign tips.

Advanced

Create external library or place with useful Tailwind components.
Create examples of AstroWind in CodeSanbox or a similar platform that can be easily synchronized with new updates. (Redesign, Integration with React or Svelte components, Use of Tailwind plugins, Connection to headless CMS ...).

Frequently Asked Questions

Why?

Related projects

Qwind - A template to make your website using Qwik + Tailwind CSS.

Contributing

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.

Acknowledgements

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

License

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

crenaz/astroWind