mikeconrad/blog
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
prototypa
2022-08-12 02:30:54 -04:00
committed by GitHub
parent 7087dcc5cc
commit e1ba1c4561
1 changed files with 31 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@ -1,27 +1,28 @@
# AstroWind # AstroWind Template
A template to make your website using Astro + Tailwind CSS. <img src="performance.png" align="right"
alt="Performance" width="100" height="358">
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! A template to make your website using **Astro + Tailwind CSS**. Ready to start a new project and designed taking into account best practices
<br> **Features**
[Live demo](https://astrowind.vercel.app/) - Excellent **integration with Tailwind CSS** via [@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/)
- Image optimization using [@astrojs/images](https://docs.astro.build/en/guides/integrations-guide/image/). Supports resizing images and encoding them to different image formats.
<br>
## 🚀 Features
- Excellent integration with Tailwind CSS via [@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/)
- Image optimization using [@astrojs/images](https://docs.astro.build/en/guides/integrations-guide/image/)
- Automatically generate the project sitemap with [@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/) - Automatically generate the project sitemap with [@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/)
- Optimize the use of fonts from Google Fonts at build time with [subfont](https://www.npmjs.com/package/subfont) npm package - Optimize the use of fonts from Google Fonts at build time with [subfont](https://www.npmjs.com/package/subfont) package
- Excellent score in Chrome Lighthouse reports (build code): - Excellent score in Chrome Lighthouse reports (build code):
- 100 Performance - 100 Performance
- 100 Accessibility - 100 Accessibility
- 100 Best Practices - 100 Best Practices
- 100 SEO - 100 SEO
- Production ready Google PageSpeed Insights - Production ready Google PageSpeed Insights score
<br>
<img src="./screenshot.png" alt="AstroWind Image">
[Live demo](https://astrowind.vercel.app/)
<br> <br>
@ -38,7 +39,7 @@ Inside AstroWind template, you'll see the following folders and files:
│ ├── assets/ │ ├── assets/
│ │ ├── images/ │ │ ├── images/
| | | └── ... | | | └── ...
| | └── styles | | └── styles/
| | └── base.css | | └── base.css
│ ├── components/ │ ├── components/
│ │ ├── astro/ │ │ ├── astro/
@ -51,7 +52,8 @@ Inside AstroWind template, you'll see the following folders and files:
│ ├── layouts/ │ ├── layouts/
│ | └── Layout.astro │ | └── Layout.astro
│ └── pages/ │ └── pages/
│ └── index.astro │ ├── index.astro
| └── ...
└── package.json └── package.json
└── ... └── ...
``` ```
@ -62,6 +64,8 @@ There's nothing special about `src/components/`, but that's where we like to put
Any static assets, like images, can be placed in the `public/` directory if they do not require any transformation or in the assets folder if they are imported directly. Any static assets, like images, can be placed in the `public/` directory if they do not require any transformation or in the assets folder if they are imported directly.
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
<br> <br>
## 🧞 Commands ## 🧞 Commands
@ -77,6 +81,15 @@ All commands are run from the root of the project, from a terminal:
<br> <br>
## 👀 Want to learn more? ## ⏳ Roadmap
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). - **Add blog**: Support for accessible, fast and SEO friendly blog
- **Documentation**: Create detailed documentation with best practices and redesign tips
- **More components**: Add more Tailwind components useful for most scenarios (Features, Contact, Call to Actions, Content, FAQs ...)
- **More Examples**: Add commonly used example pages (Ex: About, Terms, Services...)
<br>
## 👀 Want more?
If you have any suggestions or find any bugs, feel free to open an issue or a pull request.