Skip to content

Repository files navigation

DevFolio: 100% Markdown-Driven Developer Portfolio

Create your professional developer portfolio in minutes - No coding required!

DevFolio is a modern, customizable portfolio template that you can personalize entirely through simple Markdown files. Perfect for developers who want a stunning online presence without touching a single line of code.

✨ Features

  • 🎨 5 Professional Themes - Ocean Blue, Royal Purple, Forest Green, Sunset Orange, Magenta Pink
  • πŸŒ“ Light & Dark Mode for each theme
  • πŸ“± Fully Responsive - Perfect on desktop, tablet, and mobile
  • πŸ“„ ATS-Friendly CV Generator - Download professional CVs in 3 templates (Harvard, Modern, Creative)
  • ⚑ Lightning Fast - Built with Next.js for optimal performance
  • 🎭 100% Markdown Customization - Change everything without coding
  • πŸ” SEO Optimized - Built-in metadata, OpenGraph, and structured data
  • β™Ώ Accessible - WCAG compliant with proper ARIA labels

πŸš€ 3-Step Customization Guide

Step 1: Clone & Install (One-Time Setup)

# Fork this repository on GitHub, then clone your fork
git clone https://github.com/YOUR-USERNAME/devfolio.git
cd devfolio

# Install dependencies
npm install

# Start development server
npm run dev

Visit http://localhost:3000 to see your portfolio!

Step 2: Personalize Your Content (Edit Markdown Files)

All customization happens in the src/content/ folder. No code editing required!

πŸ“ personal-info.md - Your Basic Information

---
name: Your Name
role: Your Job Title
location: Your City - Country
---

πŸ’Ό cv.md - Your Professional Experience

---
experiences:
  - title: Your Job Title
    company: Company Name
    period: From YYYY.MM to Present
    location: City, Country
    description: What you did in this role

education:
  - degree: Your Degree
    institution: University Name
    year: YYYY

skills:
  - name: JavaScript
  - name: React
  # Add all your skills
---

🎯 projects.md - Your Portfolio Projects

---
projects:
  - title: Project Name
    description: What this project does
    image: /path-to-image.jpg
    link: https://github.com/username/project
  # Add more projects
---

πŸ”— social-links.md - Your Social Profiles

---
linkedin: https://linkedin.com/in/your-profile
github: https://github.com/your-username
email: your-email@example.com
---

🎨 site-config.md - Site Settings

---
site_name: YourSite
site_title: Your Professional Portfolio
site_description: Your portfolio description
site_url: https://your-domain.com

footer:
  show_creator_link: true  # Set to false to remove "Created by CharlyAutomatiza"
  creator_text: CharlyAutomatiza
  creator_url: https://charlyautomatiza.tech/
  rights_text: All rights reserved
---

πŸ’¬ ui-text.md - Customize All Button Text & Labels

---
nav:
  home: Home
  portfolio: Portfolio
  cv: CV

hero:
  greeting: "Hi, I'm"
  cta_primary: View Portfolio
  
# Customize any text on your site!
---

Step 3: Deploy Your Site

Deploy to Vercel (Recommended - Free)

  1. Push your changes to GitHub
  2. Go to vercel.com and sign in with GitHub
  3. Click "New Project" and select your DevFolio repository
  4. Click "Deploy" - Done! πŸŽ‰

Configure Environment Variables (Optional)

In your Vercel dashboard, add these environment variables:

NEXT_PUBLIC_SITE_URL=https://your-domain.vercel.app
DEV_MODE=false
SWITCH_THEME=true  # Enable theme selector in production

πŸ“‹ All Markdown Configuration Files

File What It Controls
personal-info.md Your name, role, location
cv.md Experience, education, skills
projects.md Portfolio projects
social-links.md LinkedIn, GitHub, email
site-config.md Site title, SEO, footer, analytics
ui-text.md All button text, labels, messages
feature-flags.md Default CV template

🎨 Theme Customization

For Development/Demo (Try All Themes)

# .env.local
DEV_MODE=true
SWITCH_THEME=true

For Production (Choose One Theme)

# .env.local
DEV_MODE=false
SWITCH_THEME=false  # Uses Magenta Pink theme by default

To let users switch themes in production:

SWITCH_THEME=true

Available theme combinations:

  • 🌊 Ocean Blue
  • πŸ‘‘ Royal Purple
  • 🌲 Forest Green
  • πŸŒ… Sunset Orange
  • πŸ’– Magenta Pink

Each theme has both light and dark modes!


πŸ“„ CV Templates

DevFolio includes 3 ATS-friendly CV templates:

  1. Harvard - Classic academic style with maximum information density
  2. Modern - Contemporary design with sidebar layout
  3. Creative - Eye-catching design while maintaining ATS compatibility

Set Default CV Template

Edit src/content/feature-flags.md:

---
DEFAULT_CV_TEMPLATE: harvard  # or modern, or creative
---

In development mode, users can preview and select any template. In production mode, the default template is automatically used for downloads.


πŸ”§ Advanced Configuration

Add Google Analytics

Edit src/content/site-config.md:

---
analytics:
  google_analytics_id: "G-XXXXXXXXXX"
  google_tag_manager_id: ""  # Optional
---

Enable Contact Form

The contact form requires Google Sheets integration. Add these environment variables:

GOOGLE_CLIENT_EMAIL=your-service-account-email
GOOGLE_PRIVATE_KEY=your-private-key
GOOGLE_SHEET_ID=your-sheet-id
NEXT_PUBLIC_GOOGLE_SHEETS_ENABLED=true

πŸ“š Need Help?

  • Documentation: All Markdown files include helpful comments
  • Issues: Open an issue on GitHub
  • Examples: Each .md file includes usage examples

πŸ› οΈ Technical Stack (For Developers)

DevFolio is built with:

  • Framework: Next.js 15 with App Router
  • Styling: Tailwind CSS
  • Animations: GSAP
  • PDF Generation: jsPDF
  • Theme Management: next-themes
  • Type Safety: TypeScript

All configuration is read from Markdown files using gray-matter, ensuring a clean separation between content and code.


πŸ“œ License

MIT License - Feel free to use this template for your portfolio!


πŸ™ Credits

Created by CharlyAutomatiza

If you found this template helpful, please give it a ⭐ on GitHub!


🚦 Quick Reference: Common Customizations

Change Your Name & Title

β†’ Edit src/content/personal-info.md

Add/Remove Projects

β†’ Edit src/content/projects.md

Update Your Experience

β†’ Edit src/content/cv.md

Change Site Title & SEO

β†’ Edit src/content/site-config.md

Customize Button Text

β†’ Edit src/content/ui-text.md

Hide "Created by CharlyAutomatiza"

β†’ Edit src/content/site-config.md and set footer.show_creator_link: false

Change Theme Colors

β†’ Choose from 5 built-in themes via the theme selector

Remember: All changes are made in Markdown files. No coding required! πŸŽ‰

About

DevFolio is a modern, responsive, and customizable portfolio template for developers. With easy-to-edit markdown files, you can showcase your projects, skills, and experience in a professional and visually appealing way.

Topics

Resources

Stars

8 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages