Skip to content

Latest commit

 

History

19 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Git2Page Banner

Your portfolio, automatically.

Git2Page is a powerful portfolio builder that creates a stunning, personalized portfolio site in minutes — no coding experience required. Simply provide your GitHub username, and Git2Page will automatically generate your portfolio. Deploy to GitHub Pages with just a few clicks.


Issues Stars Forks Last Commit Contributions Welcome License

View Demo  ·  Report Bug  ·  Request Feature


✨ Features

✅ Easy to Setup 🎨 42 Themes 📊 Google Analytics 🔥 Hotjar
🔍 SEO 📱 PWA 👤 Avatar & Bio 🔗 Social Links
💡 Skills 💼 Experience 🎓 Certifications 📚 Education
🚀 Projects 📄 Publications 📝 Blog Posts ⬇️ Resume Download

🛠 Installation & Setup

There are two ways to use Git2Page:

🍴 Forking this repo (recommended)

Show / Hide steps

Note: After forking, replace git2page.config.ts with your own config from git2page.config.template.ts. See git2page.config.example.ts for reference.

  1. Fork the repo — Click here to fork the repo so you have your own project to customize.

  2. Rename the repo

    • To host at https://<USERNAME>.github.io, rename to username.github.io
    • To host at https://<USERNAME>.github.io/<REPO_NAME>, rename to <REPO_NAME>
  3. Enable workflows — Go to your repo's Actions tab and enable workflows.

  4. Set the base value — Open git2page.config.ts and change base:

    • Deploying to https://<USERNAME>.github.io → set base to '/'
    • Deploying to https://<USERNAME>.github.io/<REPO_NAME> → set base to '/<REPO_NAME>/'
    // git2page.config.ts
    {
      base: '/',
      // ...
    }
  5. Commit the changes — Commit to your master branch. Wait a few minutes for the CI/CD pipeline to publish your website to GitHub Pages. Check the Actions tab for progress.

Your portfolio will be live shortly. Any time you commit to master, the website updates automatically.

[!NOTE] If Source is not set to GitHub Actions, go to SettingsPagesBuild and deployment and set it.

For a custom domain, add it in SettingsPagesCustom domain. No CNAME file required.

[!NOTE] If deploying with Vercel, set base to /.

As this is a Vite project, you can also host on Netlify, Vercel, Heroku, or other popular services. See the Vite deployment guide for details.

Not working? Ask in Discussions

💻 Setting up locally

Show / Hide steps

Note: For local development, replace git2page.config.ts with your own config from git2page.config.template.ts. See git2page.config.example.ts for reference.

  1. Clone and enter the project

    git clone https://github.com/zpt0/Git2Page.git
    cd Git2Page
  2. Install dependencies

    npm install
  3. Run dev server

    npm run dev
  4. Visit http://localhost:5173/Git2Page/ in your browser.

❤️ Support

Show your support by starring this project! ★


Star History Chart

🤝 Contributing

Contributions are welcome! Whether it's a bug fix, new feature, or improved documentation — we'd love your help.


See the Contributing Guide for details.


Contributors

Thanks goes to these wonderful people for their contributions:

Contributors

Become a contributor

📄 License

This project is licensed under the MIT License.

See LICENSE for details.



Copyright © 2026 zpt0. All rights reserved.


Built with ❤️ and Git2Page

About

Create and publish a dynamic portfolio by just providing your GitHub username.

Resources

Code of conduct

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages