74 lines
3.3 KiB
Markdown
74 lines
3.3 KiB
Markdown
# Astro & Tailwind CSS Starter Kit
|
||
|
||
## 🔥 Features
|
||
|
||
Explore the Astro.js Personal Blog Template – a sleek and feature-rich platform for your personal blog:
|
||
|
||
- **Astro.js Powered**: Dynamic and efficient JavaScript-driven experience.
|
||
- **Tailwind CSS Integration**: Ensures a stylish and responsive design.
|
||
- **RSS Feed Support**: Keeps your audience updated effortlessly.
|
||
- **Markdown Compatibility**: Streamlines content creation with easy formatting.
|
||
- **Syntax Highlighting**: Enhances code snippet readability for tech enthusiasts.
|
||
- **SEO-Optimized**: Includes a sitemap for optimal search engine visibility.
|
||
- **Vercel Deployment:** preconfigured Vercel deployment & web analytics.
|
||
- **Framework of your choice:** 100% Astro.js only template - choose your JS Framework (react preinstalled)
|
||
|
||
Unlock a seamless blend of aesthetics and functionality to share your unique voice with the world.
|
||
|
||
## 💻 Showcase
|
||
|
||
|
||
|
||
## 📦 Template Integrations
|
||
|
||
- @astrojs/tailwind - https://docs.astro.build/en/guides/integrations-guide/tailwind/
|
||
- @astrojs/react - https://docs.astro.build/en/guides/integrations-guide/react/
|
||
- @astrojs/sitemap - https://docs.astro.build/en/guides/integrations-guide/sitemap/
|
||
- @astrojs/rss - https://docs.astro.build/en/guides/rss/
|
||
- @vercel/analytics - https://vercel.com/docs/analytics/
|
||
- rehype-pretty-code - https://rehype-pretty-code.netlify.app/
|
||
|
||
## 🏛️ Template Structure
|
||
|
||
Inside of your Astro project, you'll see the following folders and files:
|
||
|
||
```
|
||
/
|
||
├── public/
|
||
├── src/
|
||
│ └── pages/
|
||
│ └── index.astro
|
||
└── 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.
|
||
|
||
## 🚀 Getting started
|
||
|
||
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 astro ...` | Run CLI commands like `astro add`, `astro check` |
|
||
| `npm run astro --help` | Get help using the Astro CLI |
|
||
|
||
|
||
## ❤️ Helping out
|
||
|
||
If you find that something isn't working right then I'm always happy to hear it to improve this starter! You can contribute in many ways and forms. Let me know by either:
|
||
|
||
1. [Filing an issue](https://github.com/nicdun/astro-tech-blog/issues)
|
||
2. [Submitting a pull request](https://github.com/nicdun/astro-tech-blog/pulls)
|
||
3. [Starting a discussion](https://github.com/nicdun/astro-tech-blog/discussions)
|
||
4. [Buying me a coffee!](https://www.buymeacoffee.com/nicdun)
|
||
|
||
## ☕ Thank you!
|
||
A big thank you to the creators of the awesome Astro static site generator and to all using this starter to make the web a bit more accessible for all people around the world :)
|