wrath/README.md
2024-12-22 18:17:22 +08:00

3.6 KiB
Raw Blame History

Astro Air

A minimalism, personal blog theme for Astro

Built with Astro Netlify Status

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

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
  • 🔍 Local search functionality
  • 💬 Commenting Integration
  • 🎨 Enhance Transition and Animation
  • ...and more

Quick Start

Deploy with Vercel

Deploy to Netlify

Configuration

Common Settings

  1. Open src/config/index.ts and customize your site settings:
export const common = {
  meta: {
    favicon: "/favicon.ico",
    url: "https://blog.sunguoqi.com",
  },
  googleAnalyticsId: "G-W37MQ05DRE",
  social: [
    {
      icon: Twitter,
      label: "X",
      link: "https://x.com/sun0225SUN",
    },
    {
      icon: Github,
      label: "GitHub",
      link: "https://github.com/sun0225SUN",
    },
  ],
  rss: true,
  navigation: {
    home: true,
    archive: true,
    custom: [
      {
        label: "CamLife",
        link: "https://camlife.cn",
      },
    ],
    about: true,
  },
  latestPosts: 8,
}

ZH Settings

export const zh = {
  ...common,
  siteName: "小孙同学",
  meta: {
    ...common.meta,
    title: "小孙同学",
    slogan: "一个浪漫的理性主义者",
    description: "读书、摄影、编程、旅行",
  },
  navigation: {
    ...common.navigation,
    custom: [
      {
        label: "影集",
        link: "https://camlife.cn",
      },
    ],
  },
}

EN Settings

export const en = {
  ...common,
  siteName: "Guoqi Sun",
  meta: {
    ...common.meta,
    title: "Guoqi Sun",
    slogan: "A Romantic Rationalist",
    description: "Reading, Photography, Programming, Traveling",
  },
  navigation: {
    ...common.navigation,
    custom: [
      {
        label: "CamLife",
        link: "https://camlife.cn",
      },
    ],
  },
}

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.