Skip to content

pm25/pm25.github.io

Repository files navigation


πŸ“° Pin-Yen's Personal Website

Hi! I'm Pin-Yen. This repository contains the complete source code for my personal website. If you like the style, feel free to check out ✨pm25/showlit, where I’ve organized my website into a template for anyone to use.

🌐 Live Demo Β· 🐞 Report Bug Β· πŸ“„ Update Log

Table of Contents
  1. About The Template
  2. Preview
  3. Getting Started
  4. Usage
  5. License
  6. Contact
  7. Acknowledgments

About The Template

This website is designed and developed by me. It showcases information about my background, including work experience, personal projects, research publications, rΓ©sumΓ©, articles I've written, and more. Feel free to explore!

I started building my personal website back in 2018 using plain HTML, CSS, and JavaScript. Since then, I’ve migrated it to a React-based version and refreshed the overall design. With the rise of modern web development tools, this latest version uses several popular frameworks and libraries, making it easier to customize and maintain. I also redesigned the UI to look more modern and consistent across different pages.

If you like the style, feel free to check out ✨pm25/showlit, a template where I’ve organized and wrapped the code used in my personal website. You're welcome to use and customize it for your own projects!

Why Showlit?

  • ⚑ Quick Setup – Get your site running in minutes.
  • 🎨 Customizable – Easily adjust the design (basic react skills required).
  • πŸ”§ Built-in Features – Includes a blog, automatic project fetching, and more.
  • πŸ‘₯ Beginner-Friendly – No advanced coding needed to get started.

Found this project useful? Give it a ⭐ to support the project!

πŸ› οΈ Built With

This project is primarily built using the following frameworks and libraries:

  • React
  • Vite
  • Tailwind CSS
  • Typescript
  • shadcn/ui

⬆️ Back to top

Preview

See how ✨Showlit looks in both light and dark themes:

🌞 Light Mode

Light Mode

🌚 Dark Mode

Dark Mode

⬆️ Back to top

Getting Started

There are two ways to use this template:

  1. πŸš€ Quick Setup - no local development required
  2. πŸ§‘β€πŸ’» Local Development & Manual Deployment

πŸš€ Quick Setup (Simplified)

This option does not require local development. Simply update the configuration files β†’ commit β†’ push. GitHub Actions will handle the build and deployment automatically.

Below is a simplified guide. For detailed instructions with screenshots, see the Quick Setup guide.


1️⃣ Create Your Repository

Click "Use this template" β†’ "Create a new repository".

On the Create a new repository page:

  • Enable "Include all branches"
  • Enter a repository name
  • Set the visibility to Public (default is Public already)
  • Click "Create repository"

2️⃣ Enable GitHub Pages

Go to your Repository Settings β†’ Pages, then configure:

  • Branch: gh-pages
  • Folder: /(root)

Click Save.


3️⃣ Update Configuration Files


4️⃣ Commit and Push Changes

Once your changes are pushed (or merged) to main branch, GitHub Actions will automatically:

  • Build the project
  • Deploy to GitHub Pages
  • Publish your website πŸŽ‰

After a few minutes, your website will be available at:

https://<your-github-username>.github.io/<your-repo-name>

⬆️ Back to top

Usage

✏️ Customize Content

You can personalize the website by updating the configuration files located in the config folder. Any changes will be automatically applied when the site is built or deployed.

For example, in config/profile.yaml, you can update the information with your owns:

profile:
  name: "Pin-Yen Huang"
  headline: "Student @ National Taiwan University"
  email: "pyhuang97@gmail.com"
  profileImage: "https://github.com/pm25.png"
  # ...other fields

Other configurable files include:

πŸ“ Add Articles

To add a article, create a folder and Markdown file inside public/articles following this structure:

# πŸ’‘ the folder name and Markdown filename must be the same
/public/articles/{slug}/{slug}.md

You can use public/articles/template/template.md as a reference.

When the site is built or deployed, any properly structured articles will be automatically included and indexed.

⬆️ Back to top

License

Distributed under the MIT License. See LICENSE for more information.

⬆️ Back to top

Contact

Pin-Yen Huang - pyhuang97@gmail.com

⬆️ Back to top

Acknowledgments

I am deeply grateful for the following tools and resources that contributed to the development of this project:

⬆️ Back to top