πŸ“‘ MASTER INDEX - Your Complete Portfolio

Welcome! πŸŽ‰

Your professional Jekyll portfolio is complete, documented, and ready to use.


🎯 START HERE (Pick Your Path)

1️⃣ I’m in a hurry! (5 minutes)

β†’ Read: QUICKSTART.md

  • Fast setup
  • Basic customization
  • Quick deployment

2️⃣ I want to understand first (15 minutes)

β†’ Read: SETUP_GUIDE.md

  • Step-by-step setup
  • Full configuration
  • Content creation

3️⃣ I want complete information (30+ minutes)

β†’ Read: README.md

  • Full documentation
  • All features explained
  • Complete guide

4️⃣ I just want the commands (2 minutes)

β†’ Read: COMMANDS.md

  • Exact commands to run
  • Quick reference

πŸ“š ALL DOCUMENTATION

Getting Started

  • QUICKSTART.md - 5-minute quick start
  • SETUP_GUIDE.md - Detailed setup guide

Reference

  • README.md - Complete documentation
  • COMMANDS.md - Command reference
  • TROUBLESHOOTING.md - Problem solving
  • PROJECT_SUMMARY.md - Project overview

πŸ“ YOUR WEBSITE FILES

Pages (Edit These!)

  • index.md - Homepage (customize welcome)
  • cv.md - Your CV (add experience)
  • blog.md - Blog listing (auto-generated)
  • courses.md - Courses (auto-generated)
  • about.md - About you (write bio)
  • 404.md - Error page

Blog Posts (Create Here)

  • _posts/2024-09-09-getting-started-with-jekyll.md (example)
  • _posts/2024-09-07-code-review-best-practices.md (example)
  • Create new: _posts/YYYY-MM-DD-your-title.md

Courses (Create Here)

  • _courses/javascript-fundamentals.md (example)
  • _courses/aws-for-developers.md (example)
  • Create new: _courses/your-course-name.md

Configuration

  • _config.yml - Site settings
  • Gemfile - Ruby dependencies
  • .gitignore - Git ignore rules

πŸš€ QUICK SETUP

cd /Users/kostapet/git/PetyoKostakov.github.io
bundle install
bundle exec jekyll serve
# Visit: http://localhost:4000

🎨 COMMON CUSTOMIZATIONS

What Edit Details
Site name _config.yml Change title:
My email _config.yml Change email:
GitHub link _config.yml Change github_username:
Homepage title index.md Edit frontmatter & content
CV/Resume cv.md Add your experience
About me about.md Write your bio
Colors assets/main.css Edit CSS variables
Navigation _includes/header.html Modify links
Footer _includes/footer.html Edit content

✍️ CREATE NEW CONTENT

Create a Blog Post

  1. Create file: _posts/2024-09-10-my-title.md
  2. Copy template: ```markdown β€” layout: post title: β€œYour Title” date: 2024-09-10 10:00:00 +0000 categories: [blog, category] tags: [tag1, tag2] β€”

Your content here…


### Create a Course
1. Create file: `_courses/course-name.md`
2. Copy template:
```markdown
---
layout: page
title: "Course Title"
description: "Short description"
level: "Beginner"
topics:
  - Topic 1
  - Topic 2
  - Topic 3
permalink: /courses/course-url/
---

Course content here...

πŸ”„ DEPLOYMENT

Deploy to GitHub Pages

# 1. Commit your changes
git add .
git commit -m "Update portfolio"

# 2. Push to GitHub
git push origin main

# 3. Enable GitHub Pages
# Settings β†’ Pages β†’ Deploy from branch β†’ main

# Your site: https://petyokostakov.github.io

πŸ“– READING GUIDE

By Time Available

2 Minutes:

  • COMMANDS.md

5 Minutes:

  • QUICKSTART.md

15 Minutes:

  • SETUP_GUIDE.md

30 Minutes:

  • README.md

10 Minutes Each:

  • PROJECT_SUMMARY.md
  • TROUBLESHOOTING.md

βœ… QUICK CHECKLIST

To Launch Today

  • Read QUICKSTART.md (2 min)
  • Run bundle install (2 min)
  • Run bundle exec jekyll serve (1 min)
  • Visit http://localhost:4000 (1 min)

To Customize This Week

  • Update _config.yml
  • Edit index.md
  • Update cv.md
  • Edit about.md

To Launch This Month

  • Delete sample posts
  • Write first blog post
  • Create first course
  • Deploy to GitHub

🎯 NAVIGATION TIPS

If you want to know about…

Topic Read Time
Quick start QUICKSTART.md 5 min
Setup SETUP_GUIDE.md 15 min
Features PROJECT_SUMMARY.md 10 min
Everything README.md 30 min
Commands COMMANDS.md 2 min
Problems TROUBLESHOOTING.md 5 min

πŸ’» USEFUL COMMANDS

# Install dependencies
bundle install

# Run development server
bundle exec jekyll serve

# Run on different port
bundle exec jekyll serve --port 4001

# Build for production
JEKYLL_ENV=production bundle exec jekyll build

# Clean build files
bundle exec jekyll clean

# Update dependencies
bundle update

πŸŽ“ FEATURES YOU HAVE

βœ… Blog System

  • Categories and tags
  • Post navigation
  • Archives support

βœ… Course Platform

  • Course grid
  • Level badges
  • Topic listings

βœ… Portfolio

  • CV/Resume page
  • About page
  • Social links

βœ… SEO

  • Meta tags
  • Sitemap
  • RSS feed

βœ… Design

  • Responsive layout
  • Professional styling
  • Mobile menu

πŸ“ž SUPPORT

Got a question?

  1. Check QUICKSTART.md (5 min)
  2. Read SETUP_GUIDE.md (15 min)
  3. See TROUBLESHOOTING.md (5 min)
  4. Browse README.md (30 min)

All answers are documented!


🌟 KEY POINTS

  1. No additional setup needed - Everything is configured
  2. Fully documented - 6+ comprehensive guides
  3. Sample content included - Learn by example
  4. Easy to customize - Edit simple files
  5. Ready to deploy - GitHub Pages ready
  6. Professional quality - Production-ready
  7. Free hosting - GitHub Pages included
  8. Latest version - Jekyll 4.3.3

πŸš€ LET’S GO!

cd /Users/kostapet/git/PetyoKostakov.github.io
bundle install
bundle exec jekyll serve
# Visit: http://localhost:4000

Your professional portfolio is waiting! 🌟


Start with: QUICKSTART.md or COMMANDS.md

Good luck! πŸŽ‰