111 lines (80 loc) · 3.86 KB

Twilight

A CMS integrated static blog template built with Astro framework.

🖥️ Live Demo 📝 Documentation

English | 中文

✨ Features

Content

CMS Functionality: Easy content management with headless 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

💻 Configuration

Clone the repository:

git clone https://github.com/Spr-Aachen/Twilight.git
# Navigate to the project directory
cd Twilight

Install dependencies:

# Install pnpm if not already installed
npm install -g pnpm
# Install project dependencies
pnpm install

Configure your blog:
- Customize blog settings inside twilight.config.yaml
- Manage site content inside src/content
Start the development server:
```
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 <filename>`	Create a new blog post

🙏 Acknowledgements

Prototype - Fuwari
Inspiration - Yukina & Mizuki
Translation - translate