Skip to content

Commit c5ec63d

Browse files
committed
docs: update README
1 parent a6e6845 commit c5ec63d

1 file changed

Lines changed: 63 additions & 26 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 63 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,80 @@
1-
# Astro Starter Kit: Minimal
1+
# Chen Yang - Academic Homepage
22

3-
```sh
4-
npm create astro@latest -- --template minimal
5-
```
3+
This is my personal academic website built with [Astro](https://astro.build) and deployed on GitHub Pages.
4+
5+
## 🌐 Website
66

7-
> πŸ§‘β€πŸš€ **Seasoned astronaut?** Delete this file. Have fun!
7+
Visit: https://yangchen73.github.io
88

9-
## πŸš€ Project Structure
9+
## πŸš€ Tech Stack
1010

11-
Inside of your Astro project, you'll see the following folders and files:
11+
- **Framework**: [Astro](https://astro.build) - Modern static site generator
12+
- **Styling**: [Tailwind CSS](https://tailwindcss.com) - Utility-first CSS framework
13+
- **Deployment**: [GitHub Pages](https://pages.github.com) + [GitHub Actions](https://github.com/features/actions)
14+
- **Fonts**: Inter + Noto Sans SC
1215

13-
```text
16+
## πŸ“ Project Structure
17+
18+
```
1419
/
15-
β”œβ”€β”€ public/
1620
β”œβ”€β”€ src/
17-
β”‚ └── pages/
18-
β”‚ └── index.astro
21+
β”‚ β”œβ”€β”€ layouts/ # Layout components
22+
β”‚ β”œβ”€β”€ pages/ # Page files
23+
β”‚ └── styles/ # Style files
24+
β”œβ”€β”€ public/ # Static assets
25+
β”‚ β”œβ”€β”€ profile.jpg # Profile photo
26+
β”‚ β”œβ”€β”€ cv.pdf # Resume
27+
β”‚ └── favicon.svg # Website icon
28+
β”œβ”€β”€ .github/workflows/ # GitHub Actions configuration
1929
└── package.json
2030
```
2131

22-
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
32+
## πŸ› οΈ Local Development
2333

24-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
34+
```bash
35+
# Install dependencies
36+
npm install
37+
38+
# Start development server
39+
npm run dev
40+
41+
# Build for production
42+
npm run build
43+
44+
# Preview build
45+
npm run preview
46+
```
47+
48+
## πŸš€ Deployment
49+
50+
The website is automatically deployed via GitHub Actions:
51+
52+
1. Push code to `main` branch
53+
2. GitHub Actions automatically builds
54+
3. Deploy to GitHub Pages
55+
56+
## πŸ“ Content Updates
57+
58+
To update website content, edit `src/pages/index.astro` file, then:
59+
60+
```bash
61+
git add .
62+
git commit -m "Update website content"
63+
git push origin main
64+
```
2565

26-
Any static assets, like images, can be placed in the `public/` directory.
66+
## 🎨 Features
2767

28-
## 🧞 Commands
68+
- ✨ Responsive design
69+
- πŸŒ™ Dark/light theme toggle
70+
- πŸ“± Mobile optimized
71+
- ⚑ Fast loading
72+
- πŸ” SEO friendly
2973

30-
All commands are run from the root of the project, from a terminal:
74+
## πŸ“„ License
3175

32-
| Command | Action |
33-
| :------------------------ | :----------------------------------------------- |
34-
| `npm install` | Installs dependencies |
35-
| `npm run dev` | Starts local dev server at `localhost:4321` |
36-
| `npm run build` | Build your production site to `./dist/` |
37-
| `npm run preview` | Preview your build locally, before deploying |
38-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
39-
| `npm run astro -- --help` | Get help using the Astro CLI |
76+
MIT License
4077

41-
## πŸ‘€ Want to learn more?
78+
---
4279

43-
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
80+
**Contact**: [GitHub](https://github.com/yangchen73)

0 commit comments

Comments
Β (0)