101 lines
2.6 KiB
Markdown
101 lines
2.6 KiB
Markdown
# Astro Air
|
|
|
|
A minimalism, personal blog theme for Astro.
|
|
|
|
> If you find this project helpful, please consider giving it a star ⭐️
|
|
|
|
[](https://astro.build) [](https://app.netlify.com/sites/astro-air/deploys)
|
|
|
|
|
|
<img style="border-radius: 10px;" src="https://cdn.jsdelivr.net/gh/sun0225SUN/astro-air/public/preview.png" alt="Astro Air">
|
|
|
|
|
|
## Showcase
|
|
|
|
- [Astro Air](https://astro-air.guoqi.dev)
|
|
- [Guoqi's blog](https://blog.sunguoqi.com)
|
|
- ...
|
|
|
|
> welcome to add your own blog to the list ❤️
|
|
|
|
## Features
|
|
|
|
- [x] 🌓 Dark mode support
|
|
- [x] 📱 Fully device responsive
|
|
- [x] 🎨 Clean and minimalist design
|
|
- [x] 📝 Markdown/MDX for content authoring
|
|
- [x] 🏄♂️ SSG static rendering, SEO friendly
|
|
- [x] 🌐 i18n support (EN/ZH)
|
|
- [x] 🔗 Social media integration
|
|
- [x] 📰 RSS feed & sitemap support
|
|
- [x] 🛠️ Google analysis integration
|
|
- [x] 💬 Commenting Integration (Twikoo)
|
|
- [ ] 🔍 Local search functionality
|
|
- [ ] 🎨 Enhance Transition and Animation
|
|
- [ ] ...and more
|
|
|
|
## Quick Start
|
|
|
|
[](https://vercel.com/new/clone?repository-url=https://github.com/sun0225SUN/astro-air)
|
|
|
|
[](https://app.netlify.com/start/deploy?repository=https://github.com/sun0225SUN/astro-air)
|
|
|
|
|
|
## Configuration
|
|
|
|
- Open `src/config/index.ts` and customize your site settings
|
|
|
|
- Open `src/config/links.ts` and customize your site links
|
|
|
|
- Open `src/config/zh(en)/about.mdx(intro.mdx、links.mdx)` and customize your pages content
|
|
|
|
## Writing Content
|
|
|
|
1. Create new blog posts in the `src/content/posts/` directory
|
|
2. Use the following frontmatter template:
|
|
|
|
```markdown
|
|
---
|
|
title: "Your Post Title"
|
|
description: "A brief description of your post"
|
|
pubDate: YYYY-MM-DD
|
|
updatedDate(optional): YYYY-MM-DD
|
|
tags(optional): ["tag1", "tag2"]
|
|
ogImage(optional): "cover image URL"
|
|
---
|
|
|
|
Your content here...
|
|
```
|
|
|
|
## Update Theme
|
|
|
|
```bash
|
|
git remote add upstream https://github.com/sun0225SUN/astro-air
|
|
|
|
git fetch upstream
|
|
|
|
git merge upstream/main --allow-unrelated-histories
|
|
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Feel free to:
|
|
|
|
1. Fork the repository
|
|
2. Create your feature branch
|
|
3. Submit a pull request
|
|
|
|
```bash
|
|
git clone https://github.com/sun0225SUN/astro-air
|
|
|
|
cd astro-air
|
|
|
|
pnpm install
|
|
|
|
pnpm dev
|
|
```
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the LICENSE file for details.
|