Portfolio Generator is a Next.js and TypeScript template that builds a single-page portfolio website from a YAML configuration file, styled with Chakra UI.
What is Portfolio Generator?
Portfolio Generator is an open-source template for creating a simple, single-page portfolio site. It takes a YAML file named config.yml as its only content source, and generates a static portfolio page that displays your social links, projects, skills, and experience. The project is built with Next.js using TypeScript and uses Chakra UI for styling. It is intended to be forked and customized, then deployed to hosting platforms such as Vercel, GitHub Pages, or any other web host. The repository does not name a specific author or maintainer.
Key Features
- YAML-driven content — Edit config.yml to set your name, socials, projects, skills, and experience; the site renders from that data.
- Project showcase — Display your work with descriptions and links in a dedicated section.
- Skills showcase — List your technical skills as a distinct section on the page.
- Experience showcase — Present your work history or resume-like experience entries.
- Social and contact links — Configurable links to your social profiles and contact methods.
- Semi-responsive design — The layout adapts to different screen sizes, though it is not fully optimized per the README.
- Next.js with TypeScript — The template uses the React framework Next.js and adds static typing with TypeScript.
- Chakra UI styling — Components and layout are built with the Chakra UI component library.
Who should use Portfolio Generator?
- Developers who want a quick portfolio — Fork the repository, edit the YAML file, and deploy a clean single-page site without building from scratch.
- Job seekers or freelancers — Showcase projects, skills, and experience in a structured single-page layout that is easy to update.
- Designers comfortable with YAML — Configure the entire site content through one file without writing HTML or JSX.
- Anyone needing a minimal deployable site — Host it on Vercel or GitHub Pages using the provided instructions.
Use cases
- Developers: Set up a personal portfolio in under an hour by editing config.yml and deploying to Vercel.
- Freelancers: Present a project portfolio and contact links to potential clients in a single page.
- Students: Share skills and experience sections for internships or graduate school applications.
How does Portfolio Generator work?
The template follows a simple workflow: fork the repository, edit config.yml with your personal details, replace favicon.ico with your own logo, customize the site code if needed, and deploy the result to Vercel, GitHub Pages, or another hosting platform. Because the page is generated from the YAML file, updating content later means editing that single file and redeploying.
Planned features
The README lists PDF resume download, dark mode, and mobile design as planned features that are not yet implemented.
