-
Clone the repository:
git clone https://github.com/Spr-Aachen/Twilight.git cd Twilight -
Install dependencies:
# Install pnpm if not already installed npm install -g pnpm # Install project dependencies pnpm install
-
Configure your blog:
- Edit
src/config.tsto customize blog settings - Update site information, theme colors, banner images, and social links
- Configure translation settings and feature page functionality
- Edit
-
Start the development server:
pnpm dev
Your blog will be available at
http://localhost:4321
- Create new posts:
pnpm new-post <filename> - Edit posts: Modify files in
src/content/posts/ - Customize special pages: Edit files in
src/content/spec/ - Add images: Place images in
src/assets/orpublic/
Deploy your blog to any static hosting platform:
- Vercel: Connect your GitHub repository to Vercel
- Netlify: Deploy directly from GitHub
- GitHub Pages: Use the included GitHub Actions workflow
- Cloudflare Pages: Connect your repository
Before deployment, update the site URL in astro.config.mjs.
All commands are run from the project root:
| Command | Action |
|---|---|
pnpm install |
Install dependencies |
pnpm dev |
Start local dev server at localhost:4321 |
pnpm build |
Build production site to ./dist/ |
pnpm preview |
Preview build locally before deployment |
pnpm check |
Run Astro error checking |
pnpm format |
Format code with Biome |
pnpm lint |
Check and fix code issues |
pnpm new-post <filename> |
Create a new blog post |
pnpm astro ... |
Run Astro CLI commands |