Skip to content

Repository files navigation

Academic Homepage (Astro + TypeScript + Tailwind)

A lightweight, static, and maintainable personal academic homepage for graduate school / PhD / RA / summer research applications.

Tech Stack

  • Astro
  • TypeScript
  • Tailwind CSS
  • Pure static output (no backend, no database)

Project Structure

.
├─ astro.config.mjs
├─ package.json
├─ postcss.config.cjs
├─ tailwind.config.mjs
├─ tsconfig.json
├─ public/
│  └─ .nojekyll
└─ src/
   ├─ components/
   │  ├─ Footer.astro
   │  ├─ Navbar.astro
   │  ├─ ProfileHero.astro
   │  ├─ ProjectCard.astro
   │  └─ SectionTitle.astro
   ├─ data/
   │  ├─ profile.ts
   │  └─ projects.ts
   ├─ layouts/
   │  └─ Layout.astro
   ├─ pages/
   │  └─ index.astro
   ├─ styles/
   │  └─ global.css
   └─ env.d.ts

Content Maintenance

Edit only these files to update your profile content:

  • src/data/profile.ts
  • src/data/projects.ts

Local Development

npm install
npm run dev

Open http://localhost:4321.

Build

npm run build
npm run preview

Production files are generated in dist/.

Deploy to GitHub Pages

Option A: GitHub Actions (Recommended)

  1. Push this project to GitHub.
  2. In repository settings, open Pages and choose GitHub Actions as the source.
  3. This step is mandatory before the first successful workflow run. If it is not enabled yet, actions/configure-pages will fail with a "not enabled and configured to build using GitHub Actions" error.
  4. This repository already includes deploy.yml, which will:
    • install dependencies
    • build the Astro site
    • deploy dist/ to GitHub Pages automatically on every push to main
  5. This workflow is configured for this repository with:
    • PUBLIC_SITE_URL=https://ruikerliang.github.io
    • PUBLIC_BASE_PATH=/

Option B: Manual Deploy

  1. Build locally: PUBLIC_SITE_URL=https://ruikerliang.github.io PUBLIC_BASE_PATH=/ npm run build
  2. Upload dist/ to your Pages branch / hosting target.
  3. Keep the same environment variables if you want canonical links and static asset paths to match the deployed site.

Notes

  • Current Pages site is configured with PUBLIC_SITE_URL=https://ruikerliang.github.io and PUBLIC_BASE_PATH=/.
  • The site is fully static and suitable for fast deployment and maintenance.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages