|
1 | | -# Astro Starter Kit: Minimal |
| 1 | +# Chen Yang - Academic Homepage |
2 | 2 |
|
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 |
6 | 6 |
|
7 | | -> π§βπ **Seasoned astronaut?** Delete this file. Have fun! |
| 7 | +Visit: https://yangchen73.github.io |
8 | 8 |
|
9 | | -## π Project Structure |
| 9 | +## π Tech Stack |
10 | 10 |
|
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 |
12 | 15 |
|
13 | | -```text |
| 16 | +## π Project Structure |
| 17 | + |
| 18 | +``` |
14 | 19 | / |
15 | | -βββ public/ |
16 | 20 | βββ 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 |
19 | 29 | βββ package.json |
20 | 30 | ``` |
21 | 31 |
|
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 |
23 | 33 |
|
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 | +``` |
25 | 65 |
|
26 | | -Any static assets, like images, can be placed in the `public/` directory. |
| 66 | +## π¨ Features |
27 | 67 |
|
28 | | -## π§ Commands |
| 68 | +- β¨ Responsive design |
| 69 | +- π Dark/light theme toggle |
| 70 | +- π± Mobile optimized |
| 71 | +- β‘ Fast loading |
| 72 | +- π SEO friendly |
29 | 73 |
|
30 | | -All commands are run from the root of the project, from a terminal: |
| 74 | +## π License |
31 | 75 |
|
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 |
40 | 77 |
|
41 | | -## π Want to learn more? |
| 78 | +--- |
42 | 79 |
|
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