π 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 startSETUP_GUIDE.md- Detailed setup guide
Reference
README.md- Complete documentationCOMMANDS.md- Command referenceTROUBLESHOOTING.md- Problem solvingPROJECT_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 settingsGemfile- 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
- Create file:
_posts/2024-09-10-my-title.md - 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.mdTROUBLESHOOTING.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?
- Check QUICKSTART.md (5 min)
- Read SETUP_GUIDE.md (15 min)
- See TROUBLESHOOTING.md (5 min)
- Browse README.md (30 min)
All answers are documented!
π KEY POINTS
- No additional setup needed - Everything is configured
- Fully documented - 6+ comprehensive guides
- Sample content included - Learn by example
- Easy to customize - Edit simple files
- Ready to deploy - GitHub Pages ready
- Professional quality - Production-ready
- Free hosting - GitHub Pages included
- 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! π