# Twilight A CMS integrated static blog template built with Astro framework. [**🖥️ Live Demo**](https://twilight.spr-aachen.com) [**📝 Documentation**](https://docs.twilight.spr-aachen.com/en) [![Bilibili](https://img.shields.io/badge/Bilibili-Intro-blue?logo=Bilibili)](https://space.bilibili.com/359461611/lists/6641229) [![YouTube](https://img.shields.io/badge/YouTube-Intro-red?logo=YouTube)](https://youtube.com/playlist?list=PLzjq8Hx1SRV7yqZQiACcCJmKPeg5D8JKe&si=Bcz2o0PF8MFvx8ec)

---

English | [**中文**](docs/README_ZH.md)

## ✨ Features ### Content - **CMS Functionality**: Easy content management with Decap CMS integration - **Data Visualization**: Visualized personal data like projects, skills etc. - **Automatic Navigation**: Automatic generation of post navigation ### Components - **Analytics Support**: Umami analytics integration for visitor insights - **Comment System**: Twikoo-powered comment functionality - **Music Player**: Background music support with playlist management - **PIO Widget**: Interactive live2d character support ### VFX - **Smooth Transition Animations**: Polished page component transition animations - **Customizable Theme Colors**: Realtime customizable color schemes - **Dynamic Wallpaper System**: Carousel support with multiple display modes - **Immersive Particle Effects**: Highly customizable animated particles ### Compability - **Modern & Responsive Design**: Fully optimized for desktop and mobile devices - **Multilingual Capability**: Built-in translation functionality for global accessibility ## 📦 Installation 1. **Clone the repository:** ```bash git clone https://github.com/Spr-Aachen/Twilight.git cd Twilight ``` 2. **Install dependencies:** ```bash # Install pnpm if not already installed npm install -g pnpm # Install project dependencies pnpm install ``` 3. **Configure your blog:** - [Customize blog settings](https://docs.twilight.spr-aachen.com/en/config/core) inside `twilight.config.yaml` - [Support CMS functionality](https://docs.twilight.spr-aachen.com/en/config/cms) inside `.env` - [Support Umami analytics](https://docs.twilight.spr-aachen.com/en/config/analytics) inside `.env` - [Manage site content](https://docs.twilight.spr-aachen.com/en/config/content) inside `src/content` 4. **Start the development server:** ```bash pnpm dev ``` ## 🚀 Deployment Deploy your blog to any static hosting platform ## ⚡ Commands | Command | Action | |:----------------------------|:----------------------------| | `pnpm lint` | Check and fix code issues | | `pnpm format` | Format code with Biome | | `pnpm check` | Run Astro error checking | | `pnpm dev` | Start local dev server | | `pnpm build` | Build site to `./dist/` | | `pnpm preview` | Preview build locally | | `pnpm astro ...` | Run Astro CLI commands | | `pnpm new-post ` | Create a new blog post | ## 🙏 Acknowledgements - Prototype - [Fuwari](https://github.com/saicaca/fuwari) - Inspiration - [Yukina](https://github.com/WhitePaper233/yukina) & [Mizuki](https://github.com/matsuzaka-yuki/Mizuki) - CMS - [astro-decap-cms-oauth](https://github.com/dorukgezici/astro-decap-cms-oauth) - Translation - [translate](https://gitee.com/mail_osc/translate) ## 🤝 Support This project is supported by Alibaba Cloud ESA for accelerated delivery, compute, and protection.