Skip to content

sun0225SUN/astro-air

Repository files navigation

Astro Air

A minimalism, personal blog theme for Astro.

If you find this project helpful, please consider giving it a star ⭐️

Built with Astro Netlify Status

Astro Air

Showcase

welcome to add your own blog to the list ❤️

Features

  • 🌓 Dark mode support
  • 📱 Fully device responsive
  • 🎨 Clean and minimalist design
  • 📝 Markdown/MDX for content authoring
  • 🏄‍♂️ SSG static rendering, SEO friendly
  • 🌐 i18n support (EN/ZH)
  • 🔗 Social media integration
  • 📰 RSS feed & sitemap support
  • 🛠️ Google analysis integration
  • 💬 Commenting Integration (Twikoo)
  • 🎨 Enhance Transition and Animation
  • 🔍 Local search functionality
  • ...and more

Quick Start

Deploy with Vercel

Deploy to Netlify

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:
---
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

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
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.