diff --git a/README.md b/README.md index bd0fee7..e69de29 100644 --- a/README.md +++ b/README.md @@ -1,98 +0,0 @@ -# Astro Air - -A minimalism, personal blog theme for Astro. - -> If you find this project helpful, please consider giving it a star ⭐️ - -[![Built with Astro](https://astro.badg.es/v1/built-with-astro/tiny.svg)](https://astro.build) [![Netlify Status](https://api.netlify.com/api/v1/badges/3e2c71b9-071f-4846-9321-41c949134ebf/deploy-status)](https://app.netlify.com/sites/astro-air/deploys) - -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) -- [x] 🎨 Enhance Transition and Animation -- [ ] πŸ” Local search functionality -- [ ] ...and more - -## Quick Start - -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/sun0225SUN/astro-air) - -[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](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.